A B C D F G H I P R S

A

add(String) - Method in interface com.hpe.caf.worker.document.model.Field

Adds the specified value to this field.

add(byte[]) - Method in interface com.hpe.caf.worker.document.model.Field

Adds the specified binary blob value to this field.

addFailure(String, String) - Method in interface com.hpe.caf.worker.document.model.Document

Records the specified failure on the document.

addReference(String) - Method in interface com.hpe.caf.worker.document.model.Field

Associates data stored in the remote data store with this field.

Application - Interface in com.hpe.caf.worker.document.model

Represents the entire service.

B

BatchSizeController - Interface in com.hpe.caf.worker.document.model

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

BulkDocumentWorker - Interface in com.hpe.caf.worker.document.extensibility

The BulkDocumentWorker interface is designed to allow multiple documents to be processed together.

C

checkHealth(HealthMonitor) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker

This method provides an opportunity for the worker to report if it has any problems which would prevent it processing documents correctly.

clear() - Method in interface com.hpe.caf.worker.document.model.Field

Removes all values from this field.

close() - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker

This method will be called when the worker is shutting down.

closeBatch() - Method in interface com.hpe.caf.worker.document.model.Documents

Draws this batch of documents to a close.

com.hpe.caf.worker.document.exceptions - package com.hpe.caf.worker.document.exceptions

This package contains exceptions which may be used by Document Worker implementations.

com.hpe.caf.worker.document.extensibility - package com.hpe.caf.worker.document.extensibility

This package contains a set of interfaces which may be implemented when developing a worker based on the Document Worker Framework.

com.hpe.caf.worker.document.model - package com.hpe.caf.worker.document.model

This package defines a set of objects which are made available by the Document Worker Framework.

createDocumentWorker(Application) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorkerFactory

Constructs a new Document Worker.

currentSize() - Method in interface com.hpe.caf.worker.document.model.Documents

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

D

Document - Interface in com.hpe.caf.worker.document.model

Represents a document being processed.

Documents - Interface in com.hpe.caf.worker.document.model

Represents a batch of documents to be processed.

DocumentWorker - Interface in com.hpe.caf.worker.document.extensibility

This is the main interface that must be implemented by a Document Worker.

DocumentWorkerFactory - Interface in com.hpe.caf.worker.document.extensibility

When a Document Worker is initialised it will first look for an implementation of this interface (using the standard Java service loader).

DocumentWorkerObject - Interface in com.hpe.caf.worker.document.model

This is the base object of the Document Worker Object Model.

DocumentWorkerTransientException - Exception in com.hpe.caf.worker.document.exceptions

A DocumentWorkerTransientException indicates that a transient failure has occurred; the operation might be able to succeed if it is retried at a later time.

DocumentWorkerTransientException(String) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException

Constructs a DocumentWorkerTransientException with a given reason.

DocumentWorkerTransientException(String, Throwable) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException

Constructs a DocumentWorkerTransientException with a given reason and cause.

DocumentWorkerTransientException(Throwable) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException

Constructs a DocumentWorkerTransientException with a given cause.

F

Field - Interface in com.hpe.caf.worker.document.model

Represents a field of the document.

Fields - Interface in com.hpe.caf.worker.document.model

Represents the collection of fields that are attached to a document.

FieldValue - Interface in com.hpe.caf.worker.document.model

Represents one of the data values of a field.

FieldValues - Interface in com.hpe.caf.worker.document.model

Represents the collection of data values that belong to a field.

G

get(String) - Method in interface com.hpe.caf.worker.document.model.Fields

Gets a field object for the specified field.

getApplication() - Method in interface com.hpe.caf.worker.document.model.DocumentWorkerObject

Returns the Application object, which represents the Document Worker itself.

getBatchSizeController() - Method in interface com.hpe.caf.worker.document.model.Application

Returns the batch size controller.

getCustomData(String) - Method in interface com.hpe.caf.worker.document.model.Document

Used to retrieve any custom data that was sent with the document, but which is not technically part of it.

getDocument() - Method in interface com.hpe.caf.worker.document.model.Field

Returns the document that this field is associated with.

getDocument() - Method in interface com.hpe.caf.worker.document.model.Fields

Returns the document that this collection of fields is associated with.

getField(String) - Method in interface com.hpe.caf.worker.document.model.Document

Gets a field object for the specified field.

getField() - Method in interface com.hpe.caf.worker.document.model.FieldValue

Returns the field that this field value is associated with.

getField() - Method in interface com.hpe.caf.worker.document.model.FieldValues

Returns the field that this collection of field values is associated with.

getFields() - Method in interface com.hpe.caf.worker.document.model.Document

Gets the list of fields currently associated with the document.

getMaximumBatchSize() - Method in interface com.hpe.caf.worker.document.model.BatchSizeController

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

getMaximumBatchTime() - Method in interface com.hpe.caf.worker.document.model.BatchSizeController

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

getName() - Method in interface com.hpe.caf.worker.document.model.Field

Retrieves the name of the field.

getReference() - Method in interface com.hpe.caf.worker.document.model.FieldValue

If this field value is a reference (i.e.

getService(Class<S>) - Method in interface com.hpe.caf.worker.document.model.Application

Returns the specified service, or null if the service has not been registered.

getService(Class<S>) - Method in interface com.hpe.caf.worker.document.model.ServiceLocator

Returns the specified service, or null if the service has not been registered.

getServiceLocator() - Method in interface com.hpe.caf.worker.document.model.Application

Returns the service locator object.

getStringValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue

Decodes the data assuming that it is a UTF-8 encoded string and returns it.

getStringValues() - Method in interface com.hpe.caf.worker.document.model.Field

Returns all the non-reference field values that contain valid UTF-8 encoded strings.

getValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue

Returns the data if the field value is not a reference (i.e.

getValues() - Method in interface com.hpe.caf.worker.document.model.Field

Returns a collection of all of the values that are currently associated with this field.

H

hasChanges() - Method in interface com.hpe.caf.worker.document.model.Field

Returns true if the field has been modified from its original state.

hasValues() - Method in interface com.hpe.caf.worker.document.model.Field

Returns true if this field has some values associated with it.

HealthMonitor - Interface in com.hpe.caf.worker.document.model

Used for reporting any health issues detected.

I

isBatchClosed() - Method in interface com.hpe.caf.worker.document.model.Documents

Returns whether or not this batch is closed.

isEmpty() - Method in interface com.hpe.caf.worker.document.model.FieldValues

Returns true if there are no field values in this collection.

isReference() - Method in interface com.hpe.caf.worker.document.model.FieldValue

Returns true if the data is actually stored in the remote data store.

isStringValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue

Checks if the field value data is a valid UTF-8 encoded string.

P

processDocument(Document) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker

Processes a single document.

processDocuments(Documents) - Method in interface com.hpe.caf.worker.document.extensibility.BulkDocumentWorker

Processes a batch of documents.

R

reportUnhealthy(String) - Method in interface com.hpe.caf.worker.document.model.HealthMonitor

This method is used during a health check to report that a health issue has been detected with the worker.

reset() - Method in interface com.hpe.caf.worker.document.model.Field

Resets the field back to its original state, undoing any changes made to it using the add() or clear() methods.

S

ServiceLocator - Interface in com.hpe.caf.worker.document.model

Used for caching and loading extra services that may be made available.

setMaximumBatchSize(int) - Method in interface com.hpe.caf.worker.document.model.BatchSizeController

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

setMaximumBatchTime(long) - Method in interface com.hpe.caf.worker.document.model.BatchSizeController

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

size() - Method in interface com.hpe.caf.worker.document.model.FieldValues

Returns the number of field values in this collection.

stream() - Method in interface com.hpe.caf.worker.document.model.Documents

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

stream() - Method in interface com.hpe.caf.worker.document.model.Fields

Returns a sequential Stream with this field collection as its source.

stream() - Method in interface com.hpe.caf.worker.document.model.FieldValues

Returns a sequential Stream with this field value collection as its source.

A B C D F G H I P R S