net.sf.mmm.search.engine.impl.lucene

Class LuceneSearchEngineBuilder

java.lang.Object

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

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

net.sf.mmm.search.engine.base.AbstractSearchEngineBuilder

net.sf.mmm.search.engine.impl.lucene.LuceneSearchEngineBuilder

All Implemented Interfaces:

SearchEngineBuilder

public class LuceneSearchEngineBuilder
extends AbstractSearchEngineBuilder

This is the implementation of SearchEngineBuilder using apache lucene as underlying search-engine.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.analysis.Analyzer	analyzer
private LuceneFieldManagerFactory	fieldManagerFactory
private org.apache.lucene.search.highlight.Formatter	highlightFormatter
private LuceneAnalyzer	luceneAnalyzer
private LuceneDirectoryBuilder	luceneDirectoryBuilder

Constructor Summary

Constructors

Constructor and Description
LuceneSearchEngineBuilder() The constructor.

Method Summary

Modifier and Type	Method and Description
ManagedSearchEngine	createSearchEngine(org.apache.lucene.index.IndexReader indexReader, SearchConfigurationHolder<? extends SearchConfiguration> configurationHolder, PeriodicRefresher refresher) This method creates a ManagedSearchEngine for an existing IndexReader.
ManagedSearchEngine	createSearchEngine(SearchEngineConfigurationHolder configurationHolder) This method creates a ManagedSearchEngine for the given configuration.
protected void	doInitialize() This method performs the actual initialization.
protected org.apache.lucene.analysis.Analyzer	getAnalyzer()
protected LuceneFieldManagerFactory	getFieldManagerFactory() This method gets the LuceneFieldManagerFactory.
protected org.apache.lucene.search.highlight.Formatter	getHighlightFormatter()
protected LuceneDirectoryBuilder	getLuceneDirectoryBuilder()
void	setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
void	setFieldManagerFactory(LuceneFieldManagerFactory fieldManagerFactory)
void	setHighlightFormatter(org.apache.lucene.search.highlight.Formatter highlightFormatter)
void	setLuceneAnalyzer(LuceneAnalyzer luceneAnalyzer) This method sets (injects) the LuceneAnalyzer.
void	setLuceneDirectoryBuilder(LuceneDirectoryBuilder luceneDirectoryBuilder)

Methods inherited from class net.sf.mmm.search.engine.base.AbstractSearchEngineBuilder

getPeriodicRefresher, getSearchDependencies, getSearchQueryBuilderFactory, setPeriodicRefresher, setSearchDependencies, setSearchQueryBuilderFactory

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

createLogger, 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

Field Detail

analyzer

private org.apache.lucene.analysis.Analyzer analyzer

See Also:

getAnalyzer()

luceneAnalyzer

private LuceneAnalyzer luceneAnalyzer

See Also:

setLuceneAnalyzer(LuceneAnalyzer)

luceneDirectoryBuilder

private LuceneDirectoryBuilder luceneDirectoryBuilder

See Also:

getLuceneDirectoryBuilder()

highlightFormatter

private org.apache.lucene.search.highlight.Formatter highlightFormatter

See Also:

getHighlightFormatter()

fieldManagerFactory

private LuceneFieldManagerFactory fieldManagerFactory

See Also:

getFieldManagerFactory()

Constructor Detail

LuceneSearchEngineBuilder

public LuceneSearchEngineBuilder()

The constructor.

Method Detail

setAnalyzer

public void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Parameters:

analyzer - is the analyzer to set

getAnalyzer

protected org.apache.lucene.analysis.Analyzer getAnalyzer()

Returns:

the analyzer

setLuceneAnalyzer

@Inject
public void setLuceneAnalyzer(LuceneAnalyzer luceneAnalyzer)

This method sets (injects) the LuceneAnalyzer. You may also use setAnalyzer(Analyzer) if you assemble this component manually.

Parameters:

luceneAnalyzer - is the luceneAnalyzer to set

setLuceneDirectoryBuilder

@Inject
public void setLuceneDirectoryBuilder(LuceneDirectoryBuilder luceneDirectoryBuilder)

Parameters:

luceneDirectoryBuilder - is the luceneDirectoryBuilder to set

getLuceneDirectoryBuilder

protected LuceneDirectoryBuilder getLuceneDirectoryBuilder()

Returns:

the luceneDirectoryBuilder

getHighlightFormatter

protected org.apache.lucene.search.highlight.Formatter getHighlightFormatter()

Returns:

the highlightFormatter

setHighlightFormatter

@Inject
public void setHighlightFormatter(org.apache.lucene.search.highlight.Formatter highlightFormatter)

Parameters:

highlightFormatter - is the highlightFormatter to set

getFieldManagerFactory

protected LuceneFieldManagerFactory getFieldManagerFactory()

This method gets the LuceneFieldManagerFactory.

Returns:

the LuceneFieldManagerFactory.

setFieldManagerFactory

@Inject
public void setFieldManagerFactory(LuceneFieldManagerFactory fieldManagerFactory)

Parameters:

fieldManagerFactory - is the fieldManagerFactory to set

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractSearchEngineBuilder

createSearchEngine

public ManagedSearchEngine createSearchEngine(SearchEngineConfigurationHolder configurationHolder)

This method creates a ManagedSearchEngine for the given configuration.

Parameters:

configurationHolder - is the SearchEngineConfigurationHolder.

Returns:

the created ManagedSearchEngine.

See Also:

SearchEngineConfigurationLoader

createSearchEngine

public ManagedSearchEngine createSearchEngine(org.apache.lucene.index.IndexReader indexReader,
                                              SearchConfigurationHolder<? extends SearchConfiguration> configurationHolder,
                                              PeriodicRefresher refresher)

This method creates a ManagedSearchEngine for an existing IndexReader.

Parameters:

indexReader - is the IndexReader.

configurationHolder - is the SearchConfigurationHolder.

refresher - is the PeriodicRefresher or null to disable auto-refresh.

Returns:

the ManagedSearchEngine.