|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryStore
An abstraction on top of Lucene Directory
handling.
Method Summary | |
---|---|
void |
afterFailedCopyFrom(String subContext,
String subIndex,
CopyFromHolder holder)
|
void |
afterSuccessfulCopyFrom(String subContext,
String subIndex,
CopyFromHolder holder)
|
CopyFromHolder |
beforeCopyFrom(String subContext,
String subIndex,
Directory dir)
|
void |
cleanIndex(Directory dir,
String subContext,
String subIndex)
If applicable, cleans the given directory. |
void |
close()
Closes the given directory. |
void |
closeDirectory(Directory dir,
String subContext,
String subIndex)
Closes the given directory. |
void |
deleteIndex(Directory dir,
String subContext,
String subIndex)
If applicable, deletes the given directory. |
Boolean |
indexExists(Directory dir)
Returns true if the inex exists, false if it does not. |
String[] |
listSubIndexes(String subContext)
Lists all the sub indexes for the given sub context. |
Directory |
open(String subContext,
String subIndex)
Opens a new Directory for the given sub context and sub index. |
void |
performScheduledTasks(Directory dir,
String subContext,
String subIndex)
Perform any scheduled tasks that are needed on the given directory. |
void |
registerEventListeners(SearchEngine searchEngine,
SearchEngineEventManager eventManager)
|
boolean |
requiresAsyncTransactionalContext()
Returns true if a transaction needs to be started when performing operations
with this store. |
String |
suggestedIndexDeletionPolicy()
Returns the suggested index deletion policy for the given store. |
boolean |
suggestedUseCompoundFile()
Returns the suggested compound file format usage. |
boolean |
supportsConcurrentCommits()
Retruns true if this store supports concurrent commits. |
boolean |
supportsConcurrentOperations()
Returns true if this store supports concurrent operations. |
Method Detail |
---|
Directory open(String subContext, String subIndex) throws SearchEngineException
Directory
for the given sub context and sub index.
SearchEngineException
String[] listSubIndexes(String subContext) throws SearchEngineException, UnsupportedOperationException
null
if the sub context
directory does not even exists.
Throws an UnsupportedOperationException
when the directory store does not support listing
sub indexes.
SearchEngineException
UnsupportedOperationException
Boolean indexExists(Directory dir) throws SearchEngineException
true
if the inex exists, false
if it does not. Can return
null
which then will cause the default checking to apply.
SearchEngineException
void deleteIndex(Directory dir, String subContext, String subIndex) throws SearchEngineException
SearchEngineException
void cleanIndex(Directory dir, String subContext, String subIndex) throws SearchEngineException
SearchEngineException
void closeDirectory(Directory dir, String subContext, String subIndex) throws SearchEngineException
SearchEngineException
void performScheduledTasks(Directory dir, String subContext, String subIndex) throws SearchEngineException
SearchEngineException
CopyFromHolder beforeCopyFrom(String subContext, String subIndex, Directory dir) throws SearchEngineException
SearchEngineException
void afterSuccessfulCopyFrom(String subContext, String subIndex, CopyFromHolder holder) throws SearchEngineException
SearchEngineException
void afterFailedCopyFrom(String subContext, String subIndex, CopyFromHolder holder) throws SearchEngineException
SearchEngineException
void registerEventListeners(SearchEngine searchEngine, SearchEngineEventManager eventManager)
void close()
boolean requiresAsyncTransactionalContext()
true
if a transaction needs to be started when performing operations
with this store.
boolean suggestedUseCompoundFile()
boolean supportsConcurrentOperations()
true
if this store supports concurrent operations.
boolean supportsConcurrentCommits()
true
if this store supports concurrent commits. If set to true
,
commits will be perfomed on different threads concurrently.
String suggestedIndexDeletionPolicy()
null
if globabl settings should be applied.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |