org.compass.core.lucene.engine.manager
Interface LuceneSearchEngineIndexManager

All Superinterfaces:

SearchEngineIndexManager

All Known Implementing Classes:

DefaultLuceneSearchEngineIndexManager

public interface LuceneSearchEngineIndexManager
extends SearchEngineIndexManager

Specialized Lucene index manager extension.

Author:

kimchy

Nested Class Summary

Nested classes/interfaces inherited from interface org.compass.core.engine.SearchEngineIndexManager

SearchEngineIndexManager.IndexOperationCallback, SearchEngineIndexManager.IndexOperationPlan, SearchEngineIndexManager.ReplaceIndexCallback

Method Summary

ExecutorManager	getExecutorManager()
LuceneSettings	getSettings()
LuceneSearchEngineStore	getStore()
TransactionContext	getTransactionContext()
LuceneIndexHolder	openIndexHolderBySubIndex(String subIndex)
IndexSearcher	openIndexSearcher(IndexReader reader)
IndexWriter	openIndexWriter(CompassSettings settings, Directory dir, boolean create)
IndexWriter	openIndexWriter(CompassSettings settings, Directory dir, boolean autoCommit, boolean create)
IndexWriter	openIndexWriter(CompassSettings settings, Directory dir, boolean autoCommit, boolean create, IndexDeletionPolicy deletionPolicy)
IndexWriter	openIndexWriter(CompassSettings settings, Directory dir, boolean autoCommit, boolean create, IndexDeletionPolicy deletionPolicy, Analyzer analyzer)
IndexWriter	openIndexWriter(CompassSettings settings, Directory dir, IndexDeletionPolicy deletionPolicy)
IndexWriter	openIndexWriter(CompassSettings settings, String subIndex)
IndexWriter	openIndexWriter(CompassSettings settings, String subIndex, boolean autoCommit)
MultiSearcher	openMultiSearcher(Searchable[] searchers)
void	refreshCache(String subIndex, IndexSearcher indexSearcher)
void	setWaitForCacheInvalidationBeforeSecondStep(long timeToWaitInMillis) Since there might be several instances of Compass running against the same index, they need to be globally notified to invalidate the cache after the commit lock has been obtained for the second step on the SearchEngineIndexManager.operate(org.compass.core.engine.SearchEngineIndexManager.IndexOperationCallback) or SearchEngineIndexManager.replaceIndex(org.compass.core.engine.SearchEngineIndexManager, org.compass.core.engine.SearchEngineIndexManager.ReplaceIndexCallback).

Methods inherited from interface org.compass.core.engine.SearchEngineIndexManager

calcSubIndexes, checkAndClearIfNotifiedAllToClearCache, cleanIndex, cleanIndex, clearCache, clearCache, close, createIndex, deleteIndex, getSubIndexes, indexExists, isCached, isCached, isLocked, isLocked, isRunning, notifyAllToClearCache, operate, performScheduledTasks, polyCalcSubIndexes, refreshCache, refreshCache, releaseLock, releaseLocks, replaceIndex, requiresAsyncTransactionalContext, start, stop, subIndexExists, supportsConcurrentOperations, verifyIndex

Method Detail

getSettings

LuceneSettings getSettings()

getStore

LuceneSearchEngineStore getStore()

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            String subIndex)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            String subIndex,
                            boolean autoCommit)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            Directory dir,
                            boolean create)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            Directory dir,
                            IndexDeletionPolicy deletionPolicy)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            Directory dir,
                            boolean autoCommit,
                            boolean create)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            Directory dir,
                            boolean autoCommit,
                            boolean create,
                            IndexDeletionPolicy deletionPolicy)
                            throws IOException

Throws:

IOException

openIndexWriter

IndexWriter openIndexWriter(CompassSettings settings,
                            Directory dir,
                            boolean autoCommit,
                            boolean create,
                            IndexDeletionPolicy deletionPolicy,
                            Analyzer analyzer)
                            throws IOException

Throws:

IOException

openIndexSearcher

IndexSearcher openIndexSearcher(IndexReader reader)

openMultiSearcher

MultiSearcher openMultiSearcher(Searchable[] searchers)
                                throws IOException

Throws:

IOException

openIndexHolderBySubIndex

LuceneIndexHolder openIndexHolderBySubIndex(String subIndex)
                                            throws SearchEngineException

Throws:

SearchEngineException

refreshCache

void refreshCache(String subIndex,
                  IndexSearcher indexSearcher)
                  throws SearchEngineException

Throws:

SearchEngineException

setWaitForCacheInvalidationBeforeSecondStep

void setWaitForCacheInvalidationBeforeSecondStep(long timeToWaitInMillis)

Since there might be several instances of Compass running against the same index, they need to be globally notified to invalidate the cache after the commit lock has been obtained for the second step on the SearchEngineIndexManager.operate(org.compass.core.engine.SearchEngineIndexManager.IndexOperationCallback) or SearchEngineIndexManager.replaceIndex(org.compass.core.engine.SearchEngineIndexManager, org.compass.core.engine.SearchEngineIndexManager.ReplaceIndexCallback).

If directly set to 0, will not wait.

Parameters:

timeToWaitInMillis -

getExecutorManager

ExecutorManager getExecutorManager()

getTransactionContext

TransactionContext getTransactionContext()