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

Interface SearchIndexerConfiguration

All Superinterfaces:

SearchConfiguration

All Known Implementing Classes:

SearchIndexerConfigurationBean

public interface SearchIndexerConfiguration
extends SearchConfiguration

This is the interface for the configuration of the SearchIndexer.
You will typically provide your configuration as XML. The base-implementation comes with an according (un)marshaler.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.search.api.config.SearchConfiguration

DEFAULT_CONFIGURATION_URL

Method Summary

Modifier and Type	Method and Description
String	getNonUtfEncoding() If you are indexing locations that contain textual content with different encodings you can enable automatic unicode detection by omitting the SearchIndexerDataLocation.getEncoding().
SearchIndexerSource	getSource(String id) This method gets the SearchSource with the given ID.
Collection<? extends SearchIndexerSource>	getSources() This method gets the Collection of sources.

Methods inherited from interface net.sf.mmm.search.api.config.SearchConfiguration

getFields, getProperties, getSearchIndex

Method Detail

getSources

Collection<? extends SearchIndexerSource> getSources()

This method gets the Collection of sources.

Specified by:

getSources in interface SearchConfiguration

Returns:

the SearchSources.

getSource

SearchIndexerSource getSource(String id)

This method gets the SearchSource with the given ID.

Specified by:

getSource in interface SearchConfiguration

Parameters:

id - is the ID of the requested SearchSource.

Returns:

the requested SearchSource or null if none is configured for the given id.

getNonUtfEncoding

String getNonUtfEncoding()

If you are indexing locations that contain textual content with different encodings you can enable automatic unicode detection by omitting the SearchIndexerDataLocation.getEncoding(). In this case if a file has an unspecified encoding, unicode encodings will be detected automatically. Otherwise this non unicode decoding is used as fallback. If not explicitly set, EncodingUtil.ENCODING_ISO_8859_15 is used.

Returns:

the non-unicode encoding.