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
 Directory getDirectory(String subIndex)
           
 ExecutorManager getExecutorManager()
          Returns an executor manager that can be used to execute / submit tasks.
 IndexHoldersCache getIndexHoldersCache()
           
 IndexWritersManager getIndexWritersManager()
           
 LuceneSearchEngineFactory getSearchEngineFactory()
           
 LuceneSettings getSettings()
           
 LuceneSearchEngineStore getStore()
           
 TransactionContext getTransactionContext()
           
 IndexSearcher openIndexSearcher(IndexReader reader)
           
 MultiSearcher openMultiSearcher(Searchable[] searchers)
           
 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, invalidateCache, invalidateCache, isCached, isCached, isLocked, isLocked, isRunning, notifyAllToClearCache, operate, performScheduledTasks, polyCalcSubIndexes, refreshCache, refreshCache, releaseLock, releaseLocks, replaceIndex, requiresAsyncTransactionalContext, start, stop, subIndexExists, supportsConcurrentCommits, supportsConcurrentOperations, verifyIndex
 

Method Detail

getSettings

LuceneSettings getSettings()

getStore

LuceneSearchEngineStore getStore()

getIndexHoldersCache

IndexHoldersCache getIndexHoldersCache()

getIndexWritersManager

IndexWritersManager getIndexWritersManager()

openIndexSearcher

IndexSearcher openIndexSearcher(IndexReader reader)

openMultiSearcher

MultiSearcher openMultiSearcher(Searchable[] searchers)
                                throws IOException
Throws:
IOException

getDirectory

Directory getDirectory(String subIndex)
                       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()
Returns an executor manager that can be used to execute / submit tasks.


getTransactionContext

TransactionContext getTransactionContext()

getSearchEngineFactory

LuceneSearchEngineFactory getSearchEngineFactory()


Copyright (c) 2004-2009 The Compass Project.