com.norconex.committer.core3

Interface ICommitter

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractBatchCommitter, AbstractCommitter, AbstractFSCommitter, CSVFileCommitter, JSONFileCommitter, LogCommitter, MemoryCommitter, XMLFileCommitter

public interface ICommitter
extends AutoCloseable

Commits documents to their final destination (e.g. search engine). Implementors are encouraged to use one of the abstract committer classes, which handles event handling and common use cases.

Since:

3.0.0

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
boolean	accept(ICommitterRequest request)
void	clean() Cleans any persisted information (e.g.
void	close()
void	delete(DeleteRequest deleteRequest)
void	init(CommitterContext committerContext)
void	upsert(UpsertRequest upsertRequest)

Method Detail

init

void init(CommitterContext committerContext)
   throws CommitterException

Throws:

CommitterException

accept

boolean accept(ICommitterRequest request)
        throws CommitterException

Throws:

CommitterException

upsert

void upsert(UpsertRequest upsertRequest)
     throws CommitterException

Throws:

CommitterException

delete

void delete(DeleteRequest deleteRequest)
     throws CommitterException

Throws:

CommitterException

close

void close()
    throws CommitterException

Specified by:

close in interface AutoCloseable

Throws:

CommitterException

clean

void clean()
    throws CommitterException

Cleans any persisted information (e.g. queue) to ensure next run will start fresh. Calling this method on Committers not persisting anything between each execution will have no effect. This method does NOT delete anything previously committed on the target repository.

Throws:

CommitterException - something went wrong cleaning the committer.