com.hpe.caf.worker.document.model

Interface InputMessageProcessor

All Superinterfaces:

DocumentWorkerObject

public interface InputMessageProcessor
extends DocumentWorkerObject

Used for controlling how messages that are received from the input queue are processed.

Method Summary

Modifier and Type	Method and Description
boolean	getDocumentTasksAccepted() Returns whether input messages in the composite document message format are accepted.
boolean	getFieldEnrichmentTasksAccepted() Returns whether input messages in the fields enrichment task message format are accepted.
boolean	getProcessSubdocumentsSeparately() Returns whether the worker's processDocument() method is called for each document in a hierarchy of documents, or whether it is only called for the root document of the document hierarchy.
void	setDocumentTasksAccepted(boolean accepted) Sets whether input messages in the composite document message format are accepted.
void	setFieldEnrichmentTasksAccepted(boolean accepted) Sets whether input messages in the fields enrichment task message format are accepted.
void	setProcessSubdocumentsSeparately(boolean processSubdocumentsSeparately) Sets whether the processDocument() method should be called for each subdocument in a document hierarchy in addition to being called for the root document of the hierarchy.

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

getApplication

Method Detail

getDocumentTasksAccepted

boolean getDocumentTasksAccepted()

Returns whether input messages in the composite document message format are accepted.

Returns:

true if the worker accepts messages in the composite document message format

See Also:

DocumentWorkerDocumentTask.java

getFieldEnrichmentTasksAccepted

boolean getFieldEnrichmentTasksAccepted()

Returns whether input messages in the fields enrichment task message format are accepted.

Returns:

true if the worker accepts messages in the fields enrichment task message format

See Also:

DocumentWorkerTask.java

getProcessSubdocumentsSeparately

boolean getProcessSubdocumentsSeparately()

Returns whether the worker's processDocument() method is called for each document in a hierarchy of documents, or whether it is only called for the root document of the document hierarchy.

If the worker implements the BulkDocumentWorker interface then this method returns whether each document in a hierarchy of documents is included in the batch of documents separately, or whether the batch of documents only includes root documents.

Returns:

true if each document in a hierarchy is processed separately

See Also:

DocumentWorker.processDocument(Document), BulkDocumentWorker.processDocuments(Documents)

setDocumentTasksAccepted

void setDocumentTasksAccepted(boolean accepted)

Sets whether input messages in the composite document message format are accepted.

Parameters:

accepted - true to accept composite document format messages, or false to reject them

See Also:

DocumentWorkerDocumentTask.java

setFieldEnrichmentTasksAccepted

void setFieldEnrichmentTasksAccepted(boolean accepted)

Sets whether input messages in the fields enrichment task message format are accepted.

Parameters:

accepted - true to accept fields enrichment task messages, or false to reject them

See Also:

DocumentWorkerTask.java

setProcessSubdocumentsSeparately

void setProcessSubdocumentsSeparately(boolean processSubdocumentsSeparately)

Sets whether the processDocument() method should be called for each subdocument in a document hierarchy in addition to being called for the root document of the hierarchy.

If the worker implements the BulkDocumentWorker interface then this setting controls whether each subdocument is added separately to the batch of documents passed for processing.

Parameters:

processSubdocumentsSeparately - true to have each subdocument processed separately

See Also:

DocumentWorker.processDocument(Document), BulkDocumentWorker.processDocuments(Documents)