com.atlassian.jira.sharing.index
Interface DefaultSharedEntityIndexer.EntityTypeConnectionManager

All Known Implementing Classes:

DefaultSharedEntityIndexer.DefaultEntityTypeConnectionManager

Enclosing class:

DefaultSharedEntityIndexer

public static interface DefaultSharedEntityIndexer.EntityTypeConnectionManager

Responsible for getting the appropriate Index for a shared entity type

Method Summary

String	clear(SharedEntity.TypeDescriptor entityType) Clear out the index for the specified type and return the path.
Collection	getAllIndexPaths()
org.apache.lucene.search.Searcher	getSearcher(SharedEntity.TypeDescriptor type) Get an Searcher for the specified type.
void	optimize(SharedEntity.TypeDescriptor type) Optimize an index.
void	shutdown(SharedEntity.TypeDescriptor entityType) Shutdown an index connection for the specified type.
void	write(SharedEntity.TypeDescriptor entityType, com.atlassian.bonnie.ILuceneConnection.WriterAction writerAction) Write something to the index.

Method Detail

getSearcher

org.apache.lucene.search.Searcher getSearcher(SharedEntity.TypeDescriptor type)

Get an Searcher for the specified type. Must be closed after use.

Parameters:

type - the SharedEntity type

Returns:

the Searcher - must not be null

write

void write(SharedEntity.TypeDescriptor entityType,
           com.atlassian.bonnie.ILuceneConnection.WriterAction writerAction)

Write something to the index.

Parameters:

entityType - the index to write to

writerAction - to perform the write

optimize

void optimize(SharedEntity.TypeDescriptor type)

Optimize an index.

Parameters:

type - the index to optimize.

clear

String clear(SharedEntity.TypeDescriptor entityType)

Clear out the index for the specified type and return the path.

Parameters:

entityType - the SharedEntity type

Returns:

the path where the indexes were

shutdown

void shutdown(SharedEntity.TypeDescriptor entityType)

Shutdown an index connection for the specified type.

Parameters:

entityType - the SharedEntity type

getAllIndexPaths

Collection getAllIndexPaths()

Returns:

all the index paths