net.sf.mmm.search.indexer.api.strategy

Interface UpdateStrategyArguments

All Known Implementing Classes:

UpdateStrategyArgumentsBean

public interface UpdateStrategyArguments

This is the interface with the properties required for the SearchIndexerUpdateStrategy. It encapsulates the state of indexing and thereby allows a SearchIndexerUpdateStrategy to be stateless and thread-safe.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
MutableGenericContext	getContext() This method gets the MutableGenericContext.
SearchIndexer	getIndexer() This method gets the SearchIndexer.
ConfiguredSearchIndexerOptions	getOptions() This method gets the ConfiguredSearchIndexerOptions.
SearchIndexerSource	getSource() This method gets the SearchIndexerSource to index (incremental) according to its update-type.
SearchIndexerSourceState	getSourceState() This method gets the SearchIndexerSourceState for the source.

Method Detail

getContext

MutableGenericContext getContext()

This method gets the MutableGenericContext.

Returns:

the MutableGenericContext.

getIndexer

SearchIndexer getIndexer()

This method gets the SearchIndexer.

Returns:

the SearchIndexer.

getOptions

ConfiguredSearchIndexerOptions getOptions()

This method gets the ConfiguredSearchIndexerOptions.

Returns:

the ConfiguredSearchIndexerOptions.

getSource

SearchIndexerSource getSource()

This method gets the SearchIndexerSource to index (incremental) according to its update-type.

Returns:

the SearchIndexerSource.

getSourceState

SearchIndexerSourceState getSourceState()

This method gets the SearchIndexerSourceState for the source.

Returns:

the SearchIndexerSourceState.