net.sf.mmm.search.indexer.base.config

Class SearchIndexerConfigurationBean

java.lang.Object

net.sf.mmm.search.base.config.AbstractSearchConfigurationBean

net.sf.mmm.search.indexer.base.config.SearchIndexerConfigurationBean

All Implemented Interfaces:

SearchConfiguration, SearchIndexerConfiguration

public class SearchIndexerConfigurationBean
extends AbstractSearchConfigurationBean
implements SearchIndexerConfiguration

This is the implementation of SearchIndexerConfiguration as JAXB-ready Java-Bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private List<FilterRuleChain<String>>	filters
private String	nonUtfEncoding
private Map<String,SearchIndexerSourceBean>	sourceMap
private List<SearchIndexerSourceBean>	sources
private List<StringTransformerChain>	transformers

Fields inherited from class net.sf.mmm.search.base.config.AbstractSearchConfigurationBean

XML_ELEMENT_SOURCE, XML_ELEMENT_SOURCES

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

DEFAULT_CONFIGURATION_URL

Constructor Summary

Constructors

Constructor and Description
SearchIndexerConfigurationBean() The constructor.

Method Summary

Modifier and Type	Method and Description
Collection<FilterRuleChain<String>>	getFilters() This method gets the List of Filters that decide which resources should be indexed.
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().
SearchIndexerSourceBean	getSource(String id) This method gets the SearchSource with the given ID.
protected Map<String,SearchIndexerSourceBean>	getSourceMap()
Collection<? extends SearchIndexerSource>	getSources() This method gets the Collection of sources.
List<StringTransformerChain>	getTransformers()
void	setFilters(List<FilterRuleChain<String>> filters) This method sets the filters.
void	setNonUtfEncoding(String nonUtfEncoding)
void	setSources(List<SearchIndexerSourceBean> sources)
void	setTransformers(List<StringTransformerChain> transformers)

Methods inherited from class net.sf.mmm.search.base.config.AbstractSearchConfigurationBean

getFields, getProperties, getRawProperties, getSearchIndex, setFields, setProperties, setSearchIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFields, getProperties, getSearchIndex

Field Detail

sources

private List<SearchIndexerSourceBean> sources

See Also:

getSources()

sourceMap

private transient Map<String,SearchIndexerSourceBean> sourceMap

See Also:

getSourceMap()

filters

private List<FilterRuleChain<String>> filters

See Also:

getFilters()

transformers

private List<StringTransformerChain> transformers

See Also:

getTransformers()

nonUtfEncoding

private String nonUtfEncoding

See Also:

getNonUtfEncoding()

Constructor Detail

SearchIndexerConfigurationBean

public SearchIndexerConfigurationBean()

The constructor.

Method Detail

getSources

public Collection<? extends SearchIndexerSource> getSources()

Description copied from interface: SearchIndexerConfiguration

This method gets the Collection of sources.

Specified by:

getSources in interface SearchConfiguration

Specified by:

getSources in interface SearchIndexerConfiguration

Returns:

the sources

getSource

public SearchIndexerSourceBean getSource(String id)

This method gets the SearchSource with the given ID.

Specified by:

getSource in interface SearchConfiguration

Specified by:

getSource in interface SearchIndexerConfiguration

Parameters:

id - is the ID of the requested SearchSource.

Returns:

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

setSources

public void setSources(List<SearchIndexerSourceBean> sources)

Parameters:

sources - is the sources to set

getSourceMap

protected Map<String,SearchIndexerSourceBean> getSourceMap()

Returns:

the sourceMap

getTransformers

public List<StringTransformerChain> getTransformers()

Returns:

the transformers

setTransformers

public void setTransformers(List<StringTransformerChain> transformers)

Parameters:

transformers - is the transformers to set

getNonUtfEncoding

public 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.

Specified by:

getNonUtfEncoding in interface SearchIndexerConfiguration

Returns:

the non-unicode encoding.

setNonUtfEncoding

public void setNonUtfEncoding(String nonUtfEncoding)

Parameters:

nonUtfEncoding - is the nonUtfEncoding to set

getFilters

public Collection<FilterRuleChain<String>> getFilters()

This method gets the List of Filters that decide which resources should be indexed.

Returns:

the Collection with the FilterRuleChains.

See Also:

SearchIndexerDataLocation.getFilter()

setFilters

public void setFilters(List<FilterRuleChain<String>> filters)

This method sets the filters.

Parameters:

filters - is the list of FilterRuleChain.