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

Interface SearchIndexerState

All Known Implementing Classes:

SearchIndexerStateBean

public interface SearchIndexerState

This is the interface for the state of the ConfiguredSearchIndexer. It is used to figure out the delta when updating the index.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
Date	getIndexingDate() This method gets the Date when the index had been updated last time.
SearchIndexerSourceState	getSourceState(String source) This method gets the SearchIndexerSourceState for the given source.

Method Detail

getSourceState

SearchIndexerSourceState getSourceState(String source)

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

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.

getIndexingDate

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.

Returns:

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