Package com.norconex.committer.core.batch

Class AbstractBatchCommitter<T extends BaseBatchCommitterConfig>

java.lang.Object

com.norconex.committer.core.AbstractCommitter<T>

com.norconex.committer.core.batch.AbstractBatchCommitter<T>

Type Parameters:

T - Committer configuration type

All Implemented Interfaces:

BatchConsumer, Committer, Configurable<T>, AutoCloseable

Direct Known Subclasses:

AmazonCloudSearchCommitter, ApacheKafkaCommitter, AzureSearchCommitter, ElasticsearchCommitter, GoogleCloudSearchCommitter, IdolCommitter, Neo4jCommitter, SolrCommitter, SqlCommitter

public abstract class AbstractBatchCommitter<T extends BaseBatchCommitterConfig>
extends AbstractCommitter<T>
implements BatchConsumer

A base implementation for doing batch commits. Uses an internal queue for storing update/addition requests and deletion requests. It sends the queued data to the remote target every time a given queue threshold has been reached. Unless otherwise stated, both additions and deletions count towards that threshold.

This class also provides batch-related events: COMMITTER_BATCH_BEGIN, COMMITTER_BATCH_END, and COMMITTER_BATCH_ERROR.

The default queue is FsQueue (file-system queue).

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractBatchCommitter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected void	closeBatchCommitter()	Subclasses can perform additional closing logic by overriding this method.
protected abstract void	commitBatch(Iterator<CommitterRequest> it)	Commits the supplied batch.
void	consume(Iterator<CommitterRequest> it)
protected void	doClean()
protected void	doClose()	Subclasses can perform additional closing logic by overriding this method.
protected void	doDelete(DeleteRequest deleteRequest)
protected final void	doInit()	Subclasses can perform additional initialization by overriding this method.
protected void	doUpsert(UpsertRequest upsertRequest)
boolean	equals(Object o)
protected CommitterQueue	getInitializedQueue()
int	hashCode()
protected void	initBatchCommitter()	Subclasses can perform additional initialization by overriding this method.
String	toString()

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.norconex.commons.lang.config.Configurable

getConfiguration

Constructor Details

AbstractBatchCommitter

public AbstractBatchCommitter()

Method Details

doInit

protected final void doInit()
                     throws CommitterException

Description copied from class: AbstractCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The CommitterContext will be initialized when invoking AbstractCommitter.getCommitterContext()

Specified by:

doInit in class AbstractCommitter<T extends BaseBatchCommitterConfig>

Throws:

CommitterException - error initializing

doUpsert

protected void doUpsert(UpsertRequest upsertRequest)
                 throws CommitterException

Specified by:

doUpsert in class AbstractCommitter<T extends BaseBatchCommitterConfig>

Throws:

CommitterException

doDelete

protected void doDelete(DeleteRequest deleteRequest)
                 throws CommitterException

Specified by:

doDelete in class AbstractCommitter<T extends BaseBatchCommitterConfig>

Throws:

CommitterException

doClose

protected void doClose()
                throws CommitterException

Description copied from class: AbstractCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Specified by:

doClose in class AbstractCommitter<T extends BaseBatchCommitterConfig>

Throws:

CommitterException - error closing committer

doClean

protected void doClean()
                throws CommitterException

Specified by:

doClean in class AbstractCommitter<T extends BaseBatchCommitterConfig>

Throws:

CommitterException

consume

public void consume(Iterator<CommitterRequest> it)
             throws CommitterException

Specified by:

consume in interface BatchConsumer

Throws:

CommitterException

getInitializedQueue

protected CommitterQueue getInitializedQueue()

initBatchCommitter

protected void initBatchCommitter()
                           throws CommitterException

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The committer context and committer queue will be already initialized when invoking AbstractCommitter.getCommitterContext() and getInitializedQueue(), respectively.

Throws:

CommitterException - error initializing

commitBatch

protected abstract void commitBatch(Iterator<CommitterRequest> it)
                             throws CommitterException

Commits the supplied batch.

Parameters:

it - the batch to commit

Throws:

CommitterException - could not commit the batch

closeBatchCommitter

protected void closeBatchCommitter()
                            throws CommitterException

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Throws:

CommitterException - error closing committer

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCommitter<T extends BaseBatchCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractCommitter<T extends BaseBatchCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCommitter<T extends BaseBatchCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractCommitter<T extends BaseBatchCommitterConfig>