com.hpe.caf.worker.document.model

Interface FieldValue

All Superinterfaces:

DocumentWorkerObject

public interface FieldValue
extends DocumentWorkerObject

Represents one of the data values of a field.

Method Summary

Modifier and Type	Method and Description
Field	getField() Returns the field that this field value is associated with.
String	getReference() If this field value is a reference (i.e.
String	getStringValue() Decodes the data assuming that it is a UTF-8 encoded string and returns it.
byte[]	getValue() Returns the data if the field value is not a reference (i.e.
boolean	isReference() Returns true if the data is actually stored in the remote data store.
boolean	isStringValue() Checks if the field value data is a valid UTF-8 encoded string.
InputStream	openInputStream() Opens an InputStream for the field value.

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

getApplication

Method Detail

getField

@Nonnull
Field getField()

Returns the field that this field value is associated with.

Returns:

the field that this field value is associated with

getStringValue

@Nonnull
String getStringValue()

Decodes the data assuming that it is a UTF-8 encoded string and returns it. The isReference() call should be used before calling this method because it throws a RuntimeException if this field value is a reference. A replacement character will be used for sequences which are not valid UTF-8.

Returns:

the field value data as a string

Throws:

RuntimeException - if this field value is a reference

getReference

@Nonnull
String getReference()

If this field value is a reference (i.e. if the data is actually stored in a remote data store) then this method retrieves the remote data store reference. The isReference() call should be used before calling this method because it throws a RuntimeException if this field value is not a reference.

Returns:

the remote data store reference to the field value data

Throws:

RuntimeException - if this field value is not a reference

getValue

@Nonnull
byte[] getValue()

Returns the data if the field value is not a reference (i.e. if the data is available without having to access a remote data store). The isReference() call should be used before calling this method because it throws a RuntimeException if this field value is a reference.

Returns:

the field value data

Throws:

RuntimeException - if this field value is a reference

isReference

boolean isReference()

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

Returns:

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

isStringValue

boolean isStringValue()

Checks if the field value data is a valid UTF-8 encoded string. The isReference() call should be used before calling this method because it throws a RuntimeException if this field value is a reference.

Returns:

whether the field value data is a valid UTF-8 encoded string

Throws:

RuntimeException - if this field value is a reference

openInputStream

@Nonnull
InputStream openInputStream()
                              throws IOException

Opens an InputStream for the field value.

At the end of the method either the stream will be successfully opened, or an exception will have been thrown.

Returns:

a new InputStream for the field value data

Throws:

IOException - if the field value data cannot be retrieved