org.sakaiproject.search.optimize.api
Interface OptimizableIndex

All Known Implementing Classes:

OptimizableIndexImpl

public interface OptimizableIndex

An optimisable index has a number of segments that could be merged and a permanent index writer into which those segments are merged

Author:

ieb

Method Summary

int	getNumberOfOptimzableSegments() Get the number of indexes that could be optimized
File[]	getOptimizableSegments() Get a list of segments that can be optimized
org.apache.lucene.index.IndexWriter	getPermanentIndexWriter()
void	removeOptimizableSegments(File[] optimzableSegments) Remove the supplied list of segments from the optimizable set

Method Detail

getOptimizableSegments

File[] getOptimizableSegments()
                              throws IndexTransactionException

Get a list of segments that can be optimized

Returns:

Throws:

IndexTransactionException

getPermanentIndexWriter

org.apache.lucene.index.IndexWriter getPermanentIndexWriter()
                                                            throws IndexTransactionException

Returns:

Throws:

IndexTransactionException

removeOptimizableSegments

void removeOptimizableSegments(File[] optimzableSegments)
                               throws IOException,
                                      IndexTransactionException

Remove the supplied list of segments from the optimizable set

Parameters:

optimzableSegments -

Throws:

IOException

IndexTransactionException

getNumberOfOptimzableSegments

int getNumberOfOptimzableSegments()
                                  throws IndexTransactionException

Get the number of indexes that could be optimized

Returns:

Throws:

JournalErrorException

IndexTransactionException