net.sf.mmm.search.indexer.api.state

Interface SearchIndexerSourceState

All Known Implementing Classes:

SearchIndexerSourceStateBean

public interface SearchIndexerSourceState

This is the interface for the state of the ConfiguredSearchIndexer for a particular source.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchIndexerState

Method Summary

Modifier and Type	Method and Description
Date	getIndexingDate() This method gets the Date when the source had been indexed last time.
SearchIndexerDataLocationState	getLocationState(String location) This method gets the state for the given location.
String	getSource() This method gets the ID of the according source.
void	setIndexingDate(Date indexingDate) This method sets the indexing-date.

Method Detail

getSource

String getSource()

This method gets the ID of the according source.

Returns:

the ID of the according source.

getIndexingDate

Date getIndexingDate()

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

Returns:

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

setIndexingDate

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.

Parameters:

indexingDate - is the new indexing-date.

getLocationState

SearchIndexerDataLocationState getLocationState(String location)

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

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.