org.compass.core.lucene.engine
Class LuceneSearchEngineFactory

java.lang.Object
  org.compass.core.lucene.engine.LuceneSearchEngineFactory

All Implemented Interfaces:

SearchEngineFactory

public class LuceneSearchEngineFactory
extends Object
implements SearchEngineFactory

Author:

kimchy

Constructor Summary

LuceneSearchEngineFactory(PropertyNamingStrategy propertyNamingStrategy, CompassSettings settings, CompassMapping mapping)

Method Summary

void	close() Closes the factory.
String	getAliasProperty() Returns the name of the alias property.
String	getAllProperty() Returns the name for the all property.
LuceneAnalyzerManager	getAnalyzerManager()
SearchEngineEventManager	getEventManager()
String	getExtendedAliasProperty() Returns the name of the extending alias property name.
LuceneHighlighterManager	getHighlighterManager()
IndexDeletionPolicyFactory	getIndexDeletionPolicyManager()
SearchEngineIndexManager	getIndexManager() Returns the index manager.
LuceneSearchEngineIndexManager	getLuceneIndexManager()
LuceneSettings	getLuceneSettings()
CompassMapping	getMapping()
SearchEngineOptimizer	getOptimizer() Returns the serach engine optimizer that was created by the factory.
PropertyNamingStrategy	getPropertyNamingStrategy() Returns the property naming strategy used by the search engine to create hidden properties.
LuceneQueryParserManager	getQueryParserManager()
CompassSettings	getSettings()
SearchEngine	openSearchEngine(RuntimeCompassSettings runtimeSettings) Opens/Creates a light weight search engine to perform search engine operations.
void	setIndexManager(LuceneSearchEngineIndexManager indexManager)
void	setOptimizer(LuceneSearchEngineOptimizer searchEngineOptimizer)

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneSearchEngineFactory

public LuceneSearchEngineFactory(PropertyNamingStrategy propertyNamingStrategy,
                                 CompassSettings settings,
                                 CompassMapping mapping)

Method Detail

close

public void close()
           throws SearchEngineException

Description copied from interface: SearchEngineFactory

Closes the factory.

Specified by:

close in interface SearchEngineFactory

Throws:

SearchEngineException

openSearchEngine

public SearchEngine openSearchEngine(RuntimeCompassSettings runtimeSettings)

Description copied from interface: SearchEngineFactory

Opens/Creates a light weight search engine to perform search engine operations.

Specified by:

openSearchEngine in interface SearchEngineFactory

Returns:

A new search engine session.

getAliasProperty

public String getAliasProperty()

Description copied from interface: SearchEngineFactory

Returns the name of the alias property.

Specified by:

getAliasProperty in interface SearchEngineFactory

Returns:

The name of the alias property.

getExtendedAliasProperty

public String getExtendedAliasProperty()

Description copied from interface: SearchEngineFactory

Returns the name of the extending alias property name.

Specified by:

getExtendedAliasProperty in interface SearchEngineFactory

getAllProperty

public String getAllProperty()

Description copied from interface: SearchEngineFactory

Returns the name for the all property.

Specified by:

getAllProperty in interface SearchEngineFactory

Returns:

The name of the all property.

getMapping

public CompassMapping getMapping()

getPropertyNamingStrategy

public PropertyNamingStrategy getPropertyNamingStrategy()

Description copied from interface: SearchEngineFactory

Returns the property naming strategy used by the search engine to create hidden properties.

Specified by:

getPropertyNamingStrategy in interface SearchEngineFactory

Returns:

The property naming strategy used.

getOptimizer

public SearchEngineOptimizer getOptimizer()

Description copied from interface: SearchEngineFactory

Returns the serach engine optimizer that was created by the factory.

Specified by:

getOptimizer in interface SearchEngineFactory

Returns:

The search engine optimizer

setOptimizer

public void setOptimizer(LuceneSearchEngineOptimizer searchEngineOptimizer)

getIndexManager

public SearchEngineIndexManager getIndexManager()

Description copied from interface: SearchEngineFactory

Returns the index manager.

Specified by:

getIndexManager in interface SearchEngineFactory

Returns:

the search engine index manager.

setIndexManager

public void setIndexManager(LuceneSearchEngineIndexManager indexManager)

getLuceneIndexManager

public LuceneSearchEngineIndexManager getLuceneIndexManager()

getLuceneSettings

public LuceneSettings getLuceneSettings()

getSettings

public CompassSettings getSettings()

getAnalyzerManager

public LuceneAnalyzerManager getAnalyzerManager()

getEventManager

public SearchEngineEventManager getEventManager()

Specified by:

getEventManager in interface SearchEngineFactory

getHighlighterManager

public LuceneHighlighterManager getHighlighterManager()
                                               throws SearchEngineException

Throws:

SearchEngineException

getQueryParserManager

public LuceneQueryParserManager getQueryParserManager()

getIndexDeletionPolicyManager

public IndexDeletionPolicyFactory getIndexDeletionPolicyManager()