atg.repository.search.indexing
Interface IncrementalLoader

public interface IncrementalLoader

Interface for incremental loading.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	adjustIncrementalQueue(IndexingOutputConfig pIOC, atg.search.index.IndexInfo pIndexInfo) Adjust incremental queue
IndexingOutputConfig	getMonitoredOutputConfigByPath(java.lang.String pPath) Return the output configuration by path.
IndexingOutputConfig[]	getMonitoredOutputConfigs() Return the monitored output configs.
boolean	getRecordChangeEvents() True if repository item change events are being recorded
void	monitor(IndexingOutputConfig pOutputConfig) Monitor repositories for the specified item descriptor.
void	monitorShadowRepositoryFor(IndexingOutputConfig pOutputConfig, boolean pEnable) Enable or disable monitoring of shadow repository for specified IndexingOutputConfig.
void	postIndexingCleanup(IndexingOutputConfig pOutputConfig, boolean pSuccess, atg.repository.search.indexing.IncrementalLoaderResults pResults) Called after a SearchAdmin indexing invocation to perform post-index housekeeping.
atg.repository.search.indexing.LoaderResults	processQueuedChangesForConfig(IndexingOutputConfig pOutputConfig, atg.search.index.IndexInfo pIndexInfo) Process the queued changes for the specified configuration.
atg.repository.search.indexing.LoaderResults	processQueuedChangesForConfig(IndexingOutputConfig pOutputConfig, java.util.Set<java.lang.Integer> pGenerations)
void	setRecordChangeEvents(boolean pRecord) True if repository item change events should be recorded
void	startLoading(IndexingOutputConfig pConfig)

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

monitor

void monitor(IndexingOutputConfig pOutputConfig)

Monitor repositories for the specified item descriptor.

Parameters:

pOutputConfig - the output configuration.

processQueuedChangesForConfig

atg.repository.search.indexing.LoaderResults processQueuedChangesForConfig(IndexingOutputConfig pOutputConfig,
                                                                           atg.search.index.IndexInfo pIndexInfo)
                                                                           throws IndexingException

Process the queued changes for the specified configuration.

Throws:

IndexingException

processQueuedChangesForConfig

atg.repository.search.indexing.LoaderResults processQueuedChangesForConfig(IndexingOutputConfig pOutputConfig,
                                                                           java.util.Set<java.lang.Integer> pGenerations)
                                                                           throws IndexingException

Throws:

IndexingException

getMonitoredOutputConfigByPath

IndexingOutputConfig getMonitoredOutputConfigByPath(java.lang.String pPath)

Return the output configuration by path.

getMonitoredOutputConfigs

IndexingOutputConfig[] getMonitoredOutputConfigs()

Return the monitored output configs.

startLoading

void startLoading(IndexingOutputConfig pConfig)

postIndexingCleanup

void postIndexingCleanup(IndexingOutputConfig pOutputConfig,
                         boolean pSuccess,
                         atg.repository.search.indexing.IncrementalLoaderResults pResults)
                         throws IndexingException

Called after a SearchAdmin indexing invocation to perform post-index housekeeping.

Parameters:

pOutputConfig - the IndexingOutputConfig for the indexing job

pSuccess - True if the overall SearchAdmin indexing process was sucessfull.

pResults - Information used clean up after a successful or unsuccessful indexing operation

Throws:

IndexingException

getRecordChangeEvents

boolean getRecordChangeEvents()

True if repository item change events are being recorded

setRecordChangeEvents

void setRecordChangeEvents(boolean pRecord)

True if repository item change events should be recorded

adjustIncrementalQueue

void adjustIncrementalQueue(IndexingOutputConfig pIOC,
                            atg.search.index.IndexInfo pIndexInfo)
                            throws IndexingException

Adjust incremental queue

Throws:

IndexingException

monitorShadowRepositoryFor

void monitorShadowRepositoryFor(IndexingOutputConfig pOutputConfig,
                                boolean pEnable)

Enable or disable monitoring of shadow repository for specified IndexingOutputConfig.

Parameters:

pOutputConfig - The relevant indexing output config

pEnable - true to enable, false to disable