org.dlese.dpc.repository.indexing

Interface ItemIndexer

All Superinterfaces:

java.util.EventListener

All Known Implementing Classes:

NDRIndexer

public interface ItemIndexer
extends java.util.EventListener

Interface for notifying watchers of indexing requests and prompts to configure and initialize.

Author:

John Weatherley

Method Summary

Modifier and Type	Method and Description
void	indexingActionRequested(IndexingEvent e) Indicates a request has been made for an indexing action to take place.
void	setConfigDirectory(java.io.File configDir) Indicates the directory where ItemIndexer config files reside.

Method Detail

setConfigDirectory

void setConfigDirectory(java.io.File configDir)
                 throws java.lang.Exception

Indicates the directory where ItemIndexer config files reside. ItemIndexer instances may work with their own configuration file and find them here. As a best practice it is recommended that the ItemIndexer use the name of its class in file names that it uses for configuration. It is up to the ItemIndexer to process these files. This method is called at start up time before any indexing events are fired and later any time the config file has been modified.

Parameters:

configDir - The directory where the config files reside

Throws:

java.lang.Exception - Exception should be thrown if an error occurs

indexingActionRequested

void indexingActionRequested(IndexingEvent e)
                      throws java.lang.Exception

Indicates a request has been made for an indexing action to take place.

Parameters:

e - The indexing event indicating the action that should take place

Throws:

java.lang.Exception - Exception should be thrown if an error occurs