org.sakaiproject.search.indexer.api
Interface IndexWorker

All Known Implementing Classes:

TransactionalIndexWorker

public interface IndexWorker

An index worker performs index operations

Author:

ieb

Method Summary

void	addIndexWorkerDocumentListener(IndexWorkerDocumentListener indexWorkerDocumentListener)
void	addIndexWorkerListener(IndexWorkerListener indexWorkerListener)
int	process(int batchSize) Perform an index cycle.
void	removeIndexWorkerDocumentListener(IndexWorkerDocumentListener indexWorkerDocumentListener)
void	removeIndexWorkerListener(IndexWorkerListener indexWorkerListener)

Method Detail

process

int process(int batchSize)

Perform an index cycle. If the indexing strategy requires locking this should be performed before invoking this method, as the implementation is not required to perform locking. Ideally the implementation should not require locking to happen and operation in a transactionally safe way.

Parameters:

batchSize - the maximum number of items to take from the queue

Returns:

the number of items processed

addIndexWorkerListener

void addIndexWorkerListener(IndexWorkerListener indexWorkerListener)

Parameters:

indexWorkerListener -

removeIndexWorkerListener

void removeIndexWorkerListener(IndexWorkerListener indexWorkerListener)

Parameters:

indexWorkerListener -

addIndexWorkerDocumentListener

void addIndexWorkerDocumentListener(IndexWorkerDocumentListener indexWorkerDocumentListener)

Parameters:

indexWorkerDocumentListener -

removeIndexWorkerDocumentListener

void removeIndexWorkerDocumentListener(IndexWorkerDocumentListener indexWorkerDocumentListener)

Parameters:

indexWorkerDocumentListener -