org.sakaiproject.search.optimize.api
Interface IndexOptimizeTransaction

All Superinterfaces:

IndexTransaction

All Known Implementing Classes:

IndexOptimizeTransactionImpl

public interface IndexOptimizeTransaction
extends IndexTransaction

An Index Optimize transaction manages an optimisation operateration where multiple transient segments produced by journaled index operations are merged into a permanent segment

Author:

ieb

Field Summary

Fields inherited from interface org.sakaiproject.search.transaction.api.IndexTransaction

STATUS_ACTIVE, STATUS_COMMITTED, STATUS_COMMITTING, STATUS_MARKED_ROLLBACK, STATUS_NO_TRANSACTION, STATUS_PREPARED, STATUS_PREPARING, STATUS_ROLLEDBACK, STATUS_ROLLING_BACK, STATUS_UNKNOWN, TRANSACTION_ACTIVE, TRANSACTION_STATUS

Method Summary

File[]	getOptimizableSegments() Get the list of segments being optimised
org.apache.lucene.index.IndexWriter	getPermanentIndexWriter() get the permanent index writer associated with this transaction, if it has been set
org.apache.lucene.index.IndexWriter	getTemporaryIndexWriter() Get the index writer associated with this transaction
void	setOptimizableSegments(File[] optimzableSegments) Set the list of segments being optimised
void	setPermanentIndexWriter(org.apache.lucene.index.IndexWriter pw) Set the index writer of the permanent index associated with this transaction

Methods inherited from interface org.sakaiproject.search.transaction.api.IndexTransaction

clear, close, commit, get, getStatus, getTransactionId, open, prepare, put, rollback

Method Detail

getTemporaryIndexWriter

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

Get the index writer associated with this transaction

Returns:

Throws:

IndexTransactionException

setPermanentIndexWriter

void setPermanentIndexWriter(org.apache.lucene.index.IndexWriter pw)

Set the index writer of the permanent index associated with this transaction

Parameters:

pw -

getPermanentIndexWriter

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

get the permanent index writer associated with this transaction, if it has been set

Returns:

setOptimizableSegments

void setOptimizableSegments(File[] optimzableSegments)

Set the list of segments being optimised

Parameters:

optimzableSegments -

getOptimizableSegments

File[] getOptimizableSegments()

Get the list of segments being optimised

Returns: