org.compass.core.engine
Interface SearchEngineFactory

All Known Subinterfaces:
InternalSearchEngineFactory
All Known Implementing Classes:
LuceneSearchEngineFactory

public interface SearchEngineFactory

A factory class that creates search engines and search engine optimizers.

Author:
kimchy

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.
 SearchEngineEventManager getEventManager()
           
 ExecutorManager getExecutorManager()
          Returns an executor manager allowing to execute tasks in an async manner as well as schedule tasks.
 String getExtendedAliasProperty()
          Returns the name of the extending alias property name.
 SearchEngineIndexManager getIndexManager()
          Returns the index manager.
 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.
 ResourceFactory getResourceFactory()
          Returns a resource factory allowing to create resources and properties.
 SearchEngineSpellCheckManager getSpellCheckManager()
          Rerturns the specll checker manager (if enabled).
 TransactionContext getTransactionContext()
          Returns a transactional context that operations that (usually) operate on a different thread or outside of a transactional context should use.
 SearchEngine openSearchEngine(RuntimeCompassSettings runtimeSettings)
          Opens/Creates a light weight search engine to perform search engine operations.
 

Method Detail

openSearchEngine

SearchEngine openSearchEngine(RuntimeCompassSettings runtimeSettings)
Opens/Creates a light weight search engine to perform search engine operations.

Returns:
A new search engine session.

getResourceFactory

ResourceFactory getResourceFactory()
Returns a resource factory allowing to create resources and properties.


getIndexManager

SearchEngineIndexManager getIndexManager()
Returns the index manager.

Returns:
the search engine index manager.

getPropertyNamingStrategy

PropertyNamingStrategy getPropertyNamingStrategy()
Returns the property naming strategy used by the search engine to create hidden properties.

Returns:
The property naming strategy used.

getOptimizer

SearchEngineOptimizer getOptimizer()
Returns the serach engine optimizer that was created by the factory.

Returns:
The search engine optimizer

getSpellCheckManager

SearchEngineSpellCheckManager getSpellCheckManager()
Rerturns the specll checker manager (if enabled).


getEventManager

SearchEngineEventManager getEventManager()

getTransactionContext

TransactionContext getTransactionContext()
Returns a transactional context that operations that (usually) operate on a different thread or outside of a transactional context should use.


getExecutorManager

ExecutorManager getExecutorManager()
Returns an executor manager allowing to execute tasks in an async manner as well as schedule tasks.


close

void close()
           throws SearchEngineException
Closes the factory.

Throws:
SearchEngineException

getAliasProperty

String getAliasProperty()
Returns the name of the alias property.

Returns:
The name of the alias property.

getExtendedAliasProperty

String getExtendedAliasProperty()
Returns the name of the extending alias property name.


getAllProperty

String getAllProperty()
Returns the name for the all property.

Returns:
The name of the all property.


Copyright (c) 2004-2008 The Compass Project.