net.sf.mmm.search.indexer.api

Interface SearchIndexerOptions

All Known Subinterfaces:

ConfiguredSearchIndexerOptions

All Known Implementing Classes:

ConfiguredSearchIndexerOptionsBean, SearchIndexerOptionsBean

public interface SearchIndexerOptions

This is the interface for the additional options for the SearchIndexer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchIndexerBuilder.createIndexer(String, SearchIndexerOptions), SearchIndexerOptionsBean

Method Summary

Modifier and Type	Method and Description
boolean	isOverwriteIndex() This method determines if a potentially existing indexer shall be overwritten.

Method Detail

isOverwriteIndex

boolean isOverwriteIndex()

This method determines if a potentially existing indexer shall be overwritten. In this case if the search-index already exists, it will be deleted and all data is lost. If no index exists yet, it will be created in any case.

Returns:

true if the index shall be overwritten, false if an existing index shall remain (and can be updated incremental).