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

Class ConfiguredSearchIndexerOptionsBean

java.lang.Object

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

All Implemented Interfaces:

ConfiguredSearchIndexerOptions, SearchIndexerOptions

public class ConfiguredSearchIndexerOptionsBean
extends Object
implements ConfiguredSearchIndexerOptions

This is the implementation of ConfiguredSearchIndexerOptions as simple java bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	nonUtfEncoding
private boolean	optimize
private boolean	overwriteEntries
private List<String>	sourceIds

Constructor Summary

Constructors

Constructor and Description
ConfiguredSearchIndexerOptionsBean() The constructor.

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.
boolean	isOverwriteIndex() This method determines if a potentially existing indexer shall be overwritten.
void	setNonUtfEncoding(String nonUtfEncoding)
void	setOptimize(boolean optimize) This method sets the optimize-flag.
void	setOverwriteEntries(boolean overwriteEntries) This method sets the overwriteEntries-flag.
void	setSourceIds(List<String> sourceIds) This method sets the source-IDs.

Methods inherited from class java.lang.Object

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

Field Detail

overwriteEntries

private boolean overwriteEntries

See Also:

isOverwriteEntries()

optimize

private boolean optimize

See Also:

isOptimize()

sourceIds

private List<String> sourceIds

See Also:

getSourceIds()

nonUtfEncoding

private String nonUtfEncoding

See Also:

getNonUtfEncoding()

Constructor Detail

ConfiguredSearchIndexerOptionsBean

public ConfiguredSearchIndexerOptionsBean()

The constructor.

Method Detail

isOptimize

public boolean isOptimize()

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

Specified by:

isOptimize in interface ConfiguredSearchIndexerOptions

Returns:

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

setOptimize

public void setOptimize(boolean optimize)

This method sets the optimize-flag.

Parameters:

optimize - is the optimize-flag to set.

isOverwriteEntries

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

Specified by:

isOverwriteEntries in interface ConfiguredSearchIndexerOptions

Returns:

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

setOverwriteEntries

public void setOverwriteEntries(boolean overwriteEntries)

This method sets the overwriteEntries-flag.
ATTENTION:
Be careful with overwriting. Your existing entries will be lost. You may loose valuable data.

Parameters:

overwriteEntries - is the overwriteEntries-flag to set.

isOverwriteIndex

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

Specified by:

isOverwriteIndex in interface SearchIndexerOptions

Returns:

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

getSourceIds

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

Specified by:

getSourceIds in interface ConfiguredSearchIndexerOptions

Returns:

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

setSourceIds

public void setSourceIds(List<String> sourceIds)

This method sets the source-IDs.

Parameters:

sourceIds - is the source-IDs to set.

getNonUtfEncoding

public String getNonUtfEncoding()

This method gets the non-UTF encoding.

Specified by:

getNonUtfEncoding in interface ConfiguredSearchIndexerOptions

Returns:

the non-UTF encoding.

See Also:

SearchIndexerConfiguration.getNonUtfEncoding()

setNonUtfEncoding

public void setNonUtfEncoding(String nonUtfEncoding)

Parameters:

nonUtfEncoding - is the nonUtfEncoding to set