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

Class SearchIndexerSourceBean

java.lang.Object

net.sf.mmm.util.lang.base.attribute.AbstractAttributeReadId<String>

net.sf.mmm.search.base.config.SearchSourceBean

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

All Implemented Interfaces:

SearchSource, SearchIndexerSource, AttributeReadId<String>

public class SearchIndexerSourceBean
extends SearchSourceBean
implements SearchIndexerSource

This is the implementation of SearchIndexerSource 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<SearchIndexerDataLocationBean>	locations
private String	updateStrategy

Fields inherited from interface net.sf.mmm.search.indexer.api.config.SearchIndexerSource

UPDATE_STRATEGY_LAST_MODIFIED, UPDATE_STRATEGY_NONE, UPDATE_STRATEGY_VCS

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

ID_ANY

Constructor Summary

Constructors

Constructor and Description
SearchIndexerSourceBean() The constructor.

Method Summary

Modifier and Type	Method and Description
List<SearchIndexerDataLocationBean>	getLocations() This method gets the List of directories.
String	getUpdateStrategy() This method gets the identifier of the strategy used for (incremental) updates of this SearchSource.
void	setLocations(List<SearchIndexerDataLocationBean> locations)
void	setUpdateStrategy(String updateStrategy) This method sets the update-strategy.

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

getId, getTitle, getUrlPrefix, setId, setTitle, setUrlPrefix, toString

Methods inherited from class net.sf.mmm.util.lang.base.attribute.AbstractAttributeReadId

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getId, getTitle, getUrlPrefix

Field Detail

updateStrategy

private String updateStrategy

See Also:

getUpdateStrategy()

locations

private List<SearchIndexerDataLocationBean> locations

See Also:

getLocations()

Constructor Detail

SearchIndexerSourceBean

public SearchIndexerSourceBean()

The constructor.

Method Detail

getUpdateStrategy

public String getUpdateStrategy()

This method gets the identifier of the strategy used for (incremental) updates of this SearchSource. This property is of interest for the search-indexer and can be ignored for the search-engine (due to the lack of full generic support in JAXB we decided NOT to move this method to a sub-interface in the search-indexer-api).
The default update-type is SearchIndexerSource.UPDATE_STRATEGY_LAST_MODIFIED that should work for all locations/resources that have a modification date. Besides SearchIndexerSource.UPDATE_STRATEGY_NONE there is also SearchIndexerSource.UPDATE_STRATEGY_VCS available.

Specified by:

getUpdateStrategy in interface SearchIndexerSource

Returns:

the type of the update mechanism or null if no delta-update-indexing shall be performed. Use one of the UPDATE_TYPE_* constants. The default implementation uses maven-scm as abstraction layer on VCS. In such case this is the role-hint for the scm-provider.

See Also:

SearchIndexerSource.UPDATE_STRATEGY_LAST_MODIFIED, SearchIndexerSource.UPDATE_STRATEGY_VCS, SearchIndexerSource.UPDATE_STRATEGY_NONE

setUpdateStrategy

public void setUpdateStrategy(String updateStrategy)

This method sets the update-strategy.

Parameters:

updateStrategy - is the new value to set.

getLocations

public List<SearchIndexerDataLocationBean> getLocations()

This method gets the List of directories.

Specified by:

getLocations in interface SearchIndexerSource

Returns:

the List of SearchIndexerDataLocation.

setLocations

public void setLocations(List<SearchIndexerDataLocationBean> locations)

Parameters:

locations - is the List of locations to set