com.hpe.caf.worker.document.model

Interface BatchSizeController

All Superinterfaces:

DocumentWorkerObject

public interface BatchSizeController
extends DocumentWorkerObject

Used for controlling the sizes of the batches passed to implementations of the BulkDocumentWorker interface.

Method Summary

Modifier and Type	Method and Description
int	getMaximumBatchSize() Gets the maximum number of documents that should be included in a batch before it is automatically closed.
long	getMaximumBatchTime() Gets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed.
void	setMaximumBatchSize(int maxBatchSize) Sets the maximum number of documents that should be included in a batch before it is automatically closed.
void	setMaximumBatchTime(long maxBatchTime) Sets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Method Detail

getMaximumBatchSize

int getMaximumBatchSize()

Gets the maximum number of documents that should be included in a batch before it is automatically closed.

Returns:

the maximum batch size

getMaximumBatchTime

long getMaximumBatchTime()

Gets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed.

Returns:

the maximum number of milliseconds that a batch should be allowed to build up for

setMaximumBatchSize

void setMaximumBatchSize(int maxBatchSize)

Sets the maximum number of documents that should be included in a batch before it is automatically closed.

Parameters:

maxBatchSize - the maximum number of documents to include in a batch

setMaximumBatchTime

void setMaximumBatchTime(long maxBatchTime)

Sets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed. Having a maximum time ensures that batches of documents continue to be processed even when the workload is such that the maximum batch size is not reached.

Parameters:

maxBatchTime - the maximum number of milliseconds to allow a batch to build up