net.sf.mmm.search.indexer.base.state

Class SearchIndexerStateBean

java.lang.Object

net.sf.mmm.search.indexer.base.state.SearchIndexerStateBean

All Implemented Interfaces:

SearchIndexerState

public class SearchIndexerStateBean
extends Object
implements SearchIndexerState

This is the implementation of SearchIndexerState 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 Date	indexingDate
private List<SearchIndexerSourceStateBean>	sources
private Map<String,SearchIndexerSourceStateBean>	sourceStateMap

Constructor Summary

Constructors

Constructor and Description
SearchIndexerStateBean() The constructor.

Method Summary

Modifier and Type	Method and Description
Date	getIndexingDate() This method gets the Date when the index had been updated last time.
SearchIndexerSourceStateBean	getOrCreateSourceState(String source)
List<SearchIndexerSourceStateBean>	getSources() This method gets the List of SearchIndexerSourceStateBean.
SearchIndexerSourceState	getSourceState(String source) This method gets the SearchIndexerSourceState for the given source.
protected Map<String,SearchIndexerSourceStateBean>	getSourceStateMap()
void	setIndexingDate(Date indexingDate) This method sets the indexing-date.
void	setSources(List<SearchIndexerSourceStateBean> sources)

Methods inherited from class java.lang.Object

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

Field Detail

indexingDate

private Date indexingDate

See Also:

getIndexingDate()

sources

private List<SearchIndexerSourceStateBean> sources

See Also:

getSources()

sourceStateMap

private transient Map<String,SearchIndexerSourceStateBean> sourceStateMap

See Also:

getSourceStateMap()

Constructor Detail

SearchIndexerStateBean

public SearchIndexerStateBean()

The constructor.

Method Detail

getSourceStateMap

protected Map<String,SearchIndexerSourceStateBean> getSourceStateMap()

Returns:

the sourceMap

getSources

public List<SearchIndexerSourceStateBean> getSources()

This method gets the List of SearchIndexerSourceStateBean.
ATTENTION:
Do NOT modify this list externally.

Returns:

the List of SearchIndexerSourceStateBeans.

See Also:

getOrCreateSourceState(String)

setSources

public void setSources(List<SearchIndexerSourceStateBean> sources)

Parameters:

sources - is the sources to set

getSourceState

public SearchIndexerSourceState getSourceState(String source)

This method gets the SearchIndexerSourceState for the given source.
For each configured source a source-state will be available.

Specified by:

getSourceState in interface SearchIndexerState

Parameters:

source - is the ID of the source for which the state is requested.

Returns:

the SearchIndexerSourceState of the given source or null if no such state exists.

getOrCreateSourceState

public SearchIndexerSourceStateBean getOrCreateSourceState(String source)

Parameters:

source - is the source-ID for which the state is requested.

Returns:

the requested SearchIndexerSourceState. If it does not exist, it is created and associated.

See Also:

getSourceState(String)

getIndexingDate

public Date getIndexingDate()

This method gets the Date when the index had been updated last time. It will be set the the current Date every time this state is saved.

Specified by:

getIndexingDate in interface SearchIndexerState

Returns:

the last indexing date or null if the index did NOT exist before.

setIndexingDate

public void setIndexingDate(Date indexingDate)

This method sets the indexing-date.

Parameters:

indexingDate - is the new indexing-date.