com.hpe.caf.worker.document.model

Interface Documents

All Superinterfaces:

DocumentWorkerObject, Iterable<Document>

public interface Documents
extends DocumentWorkerObject, Iterable<Document>

Represents a batch of documents to be processed. Each document contains a set of fields and may contain some custom data with regard to how it should be processed.

Method Summary

Modifier and Type	Method and Description
void	closeBatch() Draws this batch of documents to a close.
int	currentSize() Returns the number of documents that are currently in this batch.
boolean	isBatchClosed() Returns whether or not this batch is closed.
Stream<Document>	stream() Returns a sequential Stream with this document batch as its source.

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

getApplication

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

closeBatch

void closeBatch()

Draws this batch of documents to a close.

Calling this method will result in no new documents being added to the batch.

currentSize

int currentSize()

Returns the number of documents that are currently in this batch.

This number will usually increase as the batch is iterated, until the batch is closed.

Returns:

the number of documents that are currently in this batch

isBatchClosed

boolean isBatchClosed()

Returns whether or not this batch is closed.

Additional documents may continue to be added to an open batch. After a batch has been closed, either automatically by the framework or manually by calling closeBatch(), no additional documents will be added to it.

Returns:

true if this batch is closed

stream

@Nonnull
Stream<Document> stream()

Returns a sequential Stream with this document batch as its source.

Returns:

a sequential Stream over the batch of documents