net.sf.mmm.search.indexer.api

Interface SearchIndexerBuilder

All Known Implementing Classes:

AbstractSearchIndexerBuilder, LuceneSearchIndexerBuilder

@ComponentSpecification
public interface SearchIndexerBuilder

This is the interface for the component that allows to create the SearchIndexer.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
SearchIndexer	createIndexer(SearchIndexerConfigurationHolder configurationHolder) This method opens a new SearchIndexer.
SearchIndexer	createIndexer(SearchIndexerConfigurationHolder configurationHolder, SearchIndexerOptions options) This method opens a new SearchIndexer.
SearchIndexer	createIndexer(String dataSource, SearchIndexerOptions options) This method opens a new SearchIndexer.

Method Detail

createIndexer

SearchIndexer createIndexer(String dataSource,
                            SearchIndexerOptions options)
                     throws SearchException

This method opens a new SearchIndexer.
ATTENTION:
Only one indexer should be open at a time (for the same dataSource). You have to close the indexer before calling this method again.
WARNING:
Be very careful when setting update to false to avoid loosing valuable data.

Parameters:

dataSource - is a string identifying the data source where the index is persisted. This is typically the absolute path to the index in the local filesystem.

options - are the SearchIndexerOptions.

Returns:

the create indexer.

Throws:

SearchException - if the operation failed.

createIndexer

SearchIndexer createIndexer(SearchIndexerConfigurationHolder configurationHolder)
                     throws SearchException

This method opens a new SearchIndexer.
ATTENTION:
Only one indexer should be open at a time (for the same location). You have to close the indexer before calling this method again.
ATTENTION:
Be careful when overwriting the search-index. You may loose valuable data.

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

Returns:

the create indexer.

Throws:

SearchException - if the operation failed.

createIndexer

SearchIndexer createIndexer(SearchIndexerConfigurationHolder configurationHolder,
                            SearchIndexerOptions options)
                     throws SearchException

This method opens a new SearchIndexer.
ATTENTION:
Only one indexer should be open at a time (for the same location). You have to close the indexer before calling this method again.
ATTENTION:
Be careful when overwriting the search-index. You may loose valuable data.

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

options - are the SearchIndexerOptions.

Returns:

the create indexer.

Throws:

SearchException - if the operation failed.