net.sf.mmm.search.indexer.base

Class AbstractSearchIndexerBuilder

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.search.indexer.base.AbstractSearchIndexerBuilder

All Implemented Interfaces:

SearchIndexerBuilder

Direct Known Subclasses:

LuceneSearchIndexerBuilder

public abstract class AbstractSearchIndexerBuilder
extends AbstractLoggableComponent
implements SearchIndexerBuilder

This is the abstract base-implementation for the SearchIndexerBuilder interface.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractSearchIndexerBuilder() The constructor.

Method Summary

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

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.search.indexer.api.SearchIndexerBuilder

createIndexer

Constructor Detail

AbstractSearchIndexerBuilder

public AbstractSearchIndexerBuilder()

The constructor.

Method Detail

createIndexer

public final 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.

Specified by:

createIndexer in interface SearchIndexerBuilder

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

public 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.

Specified by:

createIndexer in interface SearchIndexerBuilder

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

Returns:

the create indexer.

Throws:

SearchException - if the operation failed.