org.sakaiproject.search.indexer.api
Interface IndexUpdateTransaction

All Superinterfaces:

IndexTransaction

All Known Implementing Classes:

IndexUpdateTransactionImpl

public interface IndexUpdateTransaction
extends IndexTransaction

This represents a transactional index operation

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

org.apache.lucene.index.IndexReader	getIndexReader()
org.apache.lucene.index.IndexWriter	getIndexWriter() Get the index writer associated with this transaction
List<SearchBuilderItem>	getItems() The list of items
String	getTempIndex()
Iterator<SearchBuilderItem>	lockedItemIterator() Get a list of add items associated with this transaction
void	setItems(List<SearchBuilderItem> items) Sets the items for the tansaction if the transaction is not open

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

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

Method Detail

getIndexWriter

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

Get the index writer associated with this transaction

Returns:

Throws:

IndexTransactionException - if the transaction is not open

getIndexReader

org.apache.lucene.index.IndexReader getIndexReader()
                                                   throws IndexTransactionException

Returns:

Throws:

IndexTransactionException

lockedItemIterator

Iterator<SearchBuilderItem> lockedItemIterator()
                                               throws IndexTransactionException

Get a list of add items associated with this transaction

Returns:

Throws:

IndexTransactionException - if the transaction is not open

getTempIndex

String getTempIndex()

Returns:

getItems

List<SearchBuilderItem> getItems()

The list of items

Returns:

setItems

void setItems(List<SearchBuilderItem> items)
              throws IndexTransactionException

Sets the items for the tansaction if the transaction is not open

Parameters:

items -

Throws:

IndexTransactionException - if the items has already been set, or the transaction is not open