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

Class SearchIndexerSourceStateBean

java.lang.Object

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

All Implemented Interfaces:

SearchIndexerSourceState

public class SearchIndexerSourceStateBean
extends Object
implements SearchIndexerSourceState

This is the implementation of SearchIndexerSourceState 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<SearchIndexerDataLocationStateBean>	locations
private Map<String,SearchIndexerDataLocationStateBean>	locationStateMap
private String	source

Constructor Summary

Constructors

Constructor and Description
SearchIndexerSourceStateBean() The constructor.

Method Summary

Modifier and Type	Method and Description
Date	getIndexingDate() This method gets the Date when the source had been indexed last time.
List<SearchIndexerDataLocationStateBean>	getLocations() This method gets the List of SearchIndexerDataLocationStateBean.
SearchIndexerDataLocationState	getLocationState(String location) This method gets the state for the given location.
protected Map<String,SearchIndexerDataLocationStateBean>	getLocationStateMap()
SearchIndexerDataLocationState	getOrCreateLocationState(String location)
String	getSource() This method gets the ID of the according source.
void	setIndexingDate(Date indexingDate) This method sets the indexing-date.
void	setLocations(List<SearchIndexerDataLocationStateBean> locations)
void	setSource(String source)

Methods inherited from class java.lang.Object

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

Field Detail

source

private String source

See Also:

getSource()

indexingDate

private Date indexingDate

See Also:

getIndexingDate()

locations

private List<SearchIndexerDataLocationStateBean> locations

See Also:

getLocations()

locationStateMap

private transient Map<String,SearchIndexerDataLocationStateBean> locationStateMap

See Also:

getLocationStateMap()

Constructor Detail

SearchIndexerSourceStateBean

public SearchIndexerSourceStateBean()

The constructor.

Method Detail

getSource

public String getSource()

Description copied from interface: SearchIndexerSourceState

This method gets the ID of the according source.

Specified by:

getSource in interface SearchIndexerSourceState

Returns:

the source

setSource

public void setSource(String source)

Parameters:

source - is the source to set

getIndexingDate

public Date getIndexingDate()

This method gets the Date when the source had been indexed last time.

Specified by:

getIndexingDate in interface SearchIndexerSourceState

Returns:

the last indexing date or null if the source has NOT yet been indexed.

setIndexingDate

public void setIndexingDate(Date indexingDate)

This method sets the indexing-date. It should be called after the source has been completely updated in the search-index.

Specified by:

setIndexingDate in interface SearchIndexerSourceState

Parameters:

indexingDate - is the new indexing-date.

getLocations

public List<SearchIndexerDataLocationStateBean> getLocations()

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

Returns:

the locations

See Also:

getOrCreateLocationState(String)

setLocations

public void setLocations(List<SearchIndexerDataLocationStateBean> locations)

Parameters:

locations - is the locations to set

getLocationStateMap

protected Map<String,SearchIndexerDataLocationStateBean> getLocationStateMap()

Returns:

the locationStateMap

getLocationState

public SearchIndexerDataLocationState getLocationState(String location)

This method gets the state for the given location.
For each configured data-location a SearchIndexerDataLocationState will be available.

Specified by:

getLocationState in interface SearchIndexerSourceState

Parameters:

location - is the location of the data-location for which the state is requested.

Returns:

the SearchIndexerDataLocationState of the given location or null if no such state exists.

getOrCreateLocationState

public SearchIndexerDataLocationState getOrCreateLocationState(String location)

Parameters:

location - is the location for which the state is requested.

Returns:

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

See Also:

getLocationState(String)