DLESE Tools
v1.6.0

org.dlese.dpc.index
Interface FileIndexingObserver

All Known Implementing Classes:
CollectionIndexingObserver, RepositoryIndexingObserver, SimpleFileIndexingObserver

public interface FileIndexingObserver

This interface is used by Objects wishing to determine when a background intexing process has completed and to perform additional processing at that time.

Author:
John Weatherley
See Also:
FileIndexingService.indexFiles(boolean, FileIndexingObserver), FileIndexingService.indexFiles(boolean, File, FileIndexingObserver)

Field Summary
static int INDEXING_COMPLETED_ABORTED
          Indicates that indexing was aborted by request
static int INDEXING_COMPLETED_DIR_DOES_NOT_EXIST
          Indicates that one or more of the indexing directories does not exist
static int INDEXING_COMPLETED_DIR_READ_ERROR
          Indicates a read error on one or more of the directories
static int INDEXING_COMPLETED_ERROR
          Indicates that indexing completed with a severe error
static int INDEXING_COMPLETED_ITEM_ERROR
          Indicates that indexing completed successfully, but one or more item was indexed with errors
static int INDEXING_COMPLETED_SUCCESS
          Indicates that indexing completed normally
 
Method Summary
 void indexingCompleted(int status, String message)
          This method is called when the indexing is complete.
 

Field Detail

INDEXING_COMPLETED_SUCCESS

static final int INDEXING_COMPLETED_SUCCESS
Indicates that indexing completed normally

See Also:
Constant Field Values

INDEXING_COMPLETED_ABORTED

static final int INDEXING_COMPLETED_ABORTED
Indicates that indexing was aborted by request

See Also:
Constant Field Values

INDEXING_COMPLETED_ERROR

static final int INDEXING_COMPLETED_ERROR
Indicates that indexing completed with a severe error

See Also:
Constant Field Values

INDEXING_COMPLETED_ITEM_ERROR

static final int INDEXING_COMPLETED_ITEM_ERROR
Indicates that indexing completed successfully, but one or more item was indexed with errors

See Also:
Constant Field Values

INDEXING_COMPLETED_DIR_DOES_NOT_EXIST

static final int INDEXING_COMPLETED_DIR_DOES_NOT_EXIST
Indicates that one or more of the indexing directories does not exist

See Also:
Constant Field Values

INDEXING_COMPLETED_DIR_READ_ERROR

static final int INDEXING_COMPLETED_DIR_READ_ERROR
Indicates a read error on one or more of the directories

See Also:
Constant Field Values
Method Detail

indexingCompleted

void indexingCompleted(int status,
                       String message)
This method is called when the indexing is complete. This method may then do additional processing that is required after indexing and will execute within the same indexing thread, thus blocking all other indexing operations until this method is returned.

Parameters:
status - The status code upon completion
message - A message describing how the indexer completed

DLESE Tools
v1.6.0