org.dlese.dpc.repository.indexing
Class IndexingEvent

java.lang.Object
  org.dlese.dpc.repository.indexing.IndexingEvent

public class IndexingEvent
extends Object

An event that describes an indexing action that has been requested.

Author:

John Weatherley

Field Summary

static int	ABORT_INDEXING Indicates the watcher should abort indexing immediately.
static int	BEGIN_INDEXING_ALL_COLLECTIONS Indicates the watcher should begin indexing all collections.
static int	BEGIN_INDEXING_COLLECTION Indicates the watcher should update a given collection.
static int	CONFIGURE_AND_INITIALIZE Indicates the watcher should update its configuration to get any changes and (re)initialize.
static int	INDEXER_READY Indicates the index is ready to recieve indexing actions.
static int	UPDATE_COLLECTIONS Indicates the watcher should update it's list of collections.

Constructor Summary

	IndexingEvent(int type) Constructor for the IndexingEvent object
protected	IndexingEvent(int type, String collectionKey, CollectionIndexer collectionIndexer) Constructor for the IndexingEvent object

Method Summary

CollectionIndexer	getCollectionIndexer() Gets the collectionIndexer attribute of the IndexingEvent object
String	getCollectionKey() Gets the collectionKey attribute of the IndexingEvent object
int	getType() Gets the event type.
String	toString() A String representation of this event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INDEXER_READY

public static final int INDEXER_READY

Indicates the index is ready to recieve indexing actions.

See Also:

Constant Field Values

UPDATE_COLLECTIONS

public static final int UPDATE_COLLECTIONS

Indicates the watcher should update it's list of collections.

See Also:

Constant Field Values

BEGIN_INDEXING_ALL_COLLECTIONS

public static final int BEGIN_INDEXING_ALL_COLLECTIONS

Indicates the watcher should begin indexing all collections.

See Also:

Constant Field Values

ABORT_INDEXING

public static final int ABORT_INDEXING

Indicates the watcher should abort indexing immediately.

See Also:

Constant Field Values

BEGIN_INDEXING_COLLECTION

public static final int BEGIN_INDEXING_COLLECTION

Indicates the watcher should update a given collection.

See Also:

Constant Field Values

CONFIGURE_AND_INITIALIZE

public static final int CONFIGURE_AND_INITIALIZE

Indicates the watcher should update its configuration to get any changes and (re)initialize.

See Also:

Constant Field Values

Constructor Detail

IndexingEvent

protected IndexingEvent(int type,
                        String collectionKey,
                        CollectionIndexer collectionIndexer)

Constructor for the IndexingEvent object

Parameters:

type - The event type

collectionKey - The collectionKey

collectionIndexer - The CollectionIndexer instance

IndexingEvent

public IndexingEvent(int type)

Constructor for the IndexingEvent object

Parameters:

type - The event type

Method Detail

getType

public int getType()

Gets the event type.

Returns:

The type value

getCollectionKey

public String getCollectionKey()

Gets the collectionKey attribute of the IndexingEvent object

Returns:

The collectionKey value

getCollectionIndexer

public CollectionIndexer getCollectionIndexer()

Gets the collectionIndexer attribute of the IndexingEvent object

Returns:

The collectionIndexer value

toString

public String toString()

A String representation of this event.

Overrides:

toString in class Object

Returns:

A String representation of this event.