com.hpe.caf.worker.document.model

Interface Fields

All Superinterfaces:

DocumentWorkerObject, Iterable<Field>

public interface Fields
extends DocumentWorkerObject, Iterable<Field>

Represents the collection of fields that are attached to a document. Each field has a name and a collection of data values.

Method Summary

Modifier and Type	Method and Description
Field	get(String fieldName) Gets a field object for the specified field.
Document	getDocument() Returns the document that this collection of fields is associated with.
void	reset() Resets this collection of fields back to its original state, undoing any changes made to any of the fields in the collection.
Stream<Field>	stream() Returns a sequential Stream with this field collection 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

get

@Nonnull
Field get(String fieldName)

Gets a field object for the specified field. This can be used to read the data values currently associated with the field, or to add or replace the data values.

Parameters:

fieldName - the name of the field to access

Returns:

the object that can be used to access or update the field

getDocument

@Nonnull
Document getDocument()

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

Returns:

the document that this collection of fields is associated with

reset

void reset()

Resets this collection of fields back to its original state, undoing any changes made to any of the fields in the collection.

stream

@Nonnull
Stream<Field> stream()

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

Returns:

a sequential Stream over the collection of fields