net.sf.mmm.search.indexer.api.config

Interface ConfiguredSearchIndexerOptions

All Superinterfaces:

SearchIndexerOptions

All Known Implementing Classes:

ConfiguredSearchIndexerOptionsBean

public interface ConfiguredSearchIndexerOptions
extends SearchIndexerOptions

This is the interface for the additional options to use for the ConfiguredSearchIndexer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

ConfiguredSearchIndexer.index(String, ConfiguredSearchIndexerOptions), ConfiguredSearchIndexerOptionsBean

Method Summary

Modifier and Type	Method and Description
String	getNonUtfEncoding() This method gets the non-UTF encoding.
List<String>	getSourceIds() This method gets the optional List of source-IDs that shall be (re-)indexed.
boolean	isOptimize() This method determines if the search-index will be optimized after indexing.
boolean	isOverwriteEntries() This method determines if all existing entries for the sources to index shall be deleted from the search-index and (re-)indexed from scratch.

Methods inherited from interface net.sf.mmm.search.indexer.api.SearchIndexerOptions

isOverwriteIndex

Method Detail

isOptimize

boolean isOptimize()

This method determines if the search-index will be optimized after indexing.

Returns:

true if the search-index will be optimized, false otherwise.

isOverwriteEntries

boolean isOverwriteEntries()

This method determines if all existing entries for the sources to index shall be deleted from the search-index and (re-)indexed from scratch. If source-IDs are NOT set (null), this is the same as SearchIndexerOptions.isOverwriteIndex().

Returns:

true if existing entries shall be overwritten, false if existing entries shall remain (and will be updated incremental).

getSourceIds

List<String> getSourceIds()

This method gets the optional List of source-IDs that shall be (re-)indexed. If the List is NOT null (default) all sources will be indexed, otherwise sources configured but NOT contained in this List will NOT be indexed.

Returns:

the List of source-IDs or null to index all sources.

getNonUtfEncoding

String getNonUtfEncoding()

This method gets the non-UTF encoding.

Returns:

the non-UTF encoding.

See Also:

SearchIndexerConfiguration.getNonUtfEncoding()