Package net.sf.mmm.search.indexer.api

Provides the API of the Search-Indexer.

See: Description

Interface Summary

Interface	Description
ConfiguredSearchIndexer	This is the interface for a high-level SearchIndexer.
CountingEntryUpdateVisitor	This interface extends EntryUpdateVisitor with a little statistic of the counts of the different changes.
EntryUpdateVisitor	This is the interface for a visitor that is notified about updates of entries.
MutableSearchEntry	This is the interface for an entry in the search index.
ResourceSearchIndexer	This is the interface for a higher-level SearchIndexer.
SearchIndexer	This is the interface for the indexer used to create and modify a search index.
SearchIndexerBuilder	This is the interface for the component that allows to create the SearchIndexer.
SearchIndexerOptions	This is the interface for the additional options for the SearchIndexer.

Package net.sf.mmm.search.indexer.api Description

Provides the API of the Search-Indexer.

Search-Indexer API

This package contains the API for a SearchIndexer. Such indexer allows to update information in a search-index so it can by found by the SearchEngine. It acts on a low level of abstraction and adapts to the underlying search-technology (e.g. apache lucene).
On top there are higher-level components that use the SearchIndexer and are independent from the underlying search-technology:

1. the ResourceSearchIndexer allows to index DataResources of arbitrary formats and extracts texts and metadata for the search index.
2. the ConfiguredSearchIndexer allows recursive indexing including incremental updates. The actual strategy for incremental indexing is realized via SearchIndexerUpdateStrategy.
3. the SearchIndexerMain offers a fully integrated main-program for performing the indexing (based on AbstractSearchIndexerMain).