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

Interface SearchIndexerUpdateStrategy

All Known Implementing Classes:

AbstractCrawlingDeltaSearchIndexer, AbstractSearchIndexerUpdateStrategy, BasicSearchIndexerUpdateStrategy, SearchIndexerUpdateStrategyLastModified, SearchIndexerUpdateStrategyNone, SearchIndexerUpdateStrategyVcs

@ComponentSpecification(plugin=true)
public interface SearchIndexerUpdateStrategy

This is the interface for the actual strategy used for the (delta-)indexing of content.
There are multiple implementations of this interface with different strategies for incremental indexing as well as for indexing from scratch every time. Implementations of this interface are typically stateful and therefore NOT thread-safe.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchIndexerUpdateStrategyManager

Method Summary

Modifier and Type	Method and Description
void	index(UpdateStrategyArguments arguments) This method performs the actual indexing.
boolean	isResponsible(SearchIndexerSource source) This method determines if this SearchIndexerUpdateStrategy is responsible for indexing the given source.

Method Detail

isResponsible

boolean isResponsible(SearchIndexerSource source)

This method determines if this SearchIndexerUpdateStrategy is responsible for indexing the given source.
Typical implementations will check if the update-strategy matches a specific value.

Parameters:

source - is the SearchIndexerSource to index (incremental) according to its update-type.

Returns:

true

See Also:

SearchIndexerUpdateStrategyManager.getStrategy(SearchIndexerSource)

index

void index(UpdateStrategyArguments arguments)

This method performs the actual indexing.

Parameters:

arguments - are the UpdateStrategyArguments for the indexing.