com.hpe.caf.worker.document

Class DocumentWorkerFieldValueValidator

java.lang.Object

com.hpe.caf.worker.testing.validation.PropertyValidator

com.hpe.caf.worker.testing.validation.CustomPropertyValidator

com.hpe.caf.worker.document.DocumentWorkerFieldValueValidator

public class DocumentWorkerFieldValueValidator
extends com.hpe.caf.worker.testing.validation.CustomPropertyValidator

A property validator that validates individual DocumentWorkerFieldValue instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.hpe.caf.worker.testing.validation.ReferenceDataValidator	referencedDataValidator
protected com.hpe.caf.worker.testing.validation.ValuePropertyValidator	simpleValueValidator

Constructor Summary

Constructors

Constructor and Description
DocumentWorkerFieldValueValidator(com.hpe.caf.api.worker.DataStore dataStore, com.hpe.caf.worker.testing.TestConfiguration testConfiguration, com.hpe.caf.api.Codec codec, String... recognizedPropertyNames) Constructs a validator that validates DocumentWorkerFieldValue instances of specific named fields

Method Summary

Modifier and Type	Method and Description
boolean	canValidate(String propertyName, Object sourcePropertyValue, Object validatorPropertyValue)
protected boolean	equal(DocumentWorkerFieldValue actual, DocumentWorkerFieldValueExpectation expected) Compares a DocumentWorkerFieldValue with an expected value and indicates if they can be considered equal.
protected byte[]	getBytes(DocumentWorkerFieldValue value) Returns byte array representation of data on provided value.
protected com.hpe.caf.util.ref.ReferencedData	getReferencedData(DocumentWorkerFieldValue actual) Retrieves ReferencedData object for data on provided DocumentWorkerFieldValue.
protected boolean	isValid(Object testedPropertyValue, Object validatorPropertyValue)
protected static String	nullToEmpty(String str) Returns an empty String if str is null otherwise returns str.
protected static DocumentWorkerFieldEncoding	nullToUtf8(DocumentWorkerFieldEncoding encoding) Returns encoding as utf8 if encoding provided is null otherwise returns encoding.

Methods inherited from class com.hpe.caf.worker.testing.validation.PropertyValidator

validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

referencedDataValidator

protected final com.hpe.caf.worker.testing.validation.ReferenceDataValidator referencedDataValidator

simpleValueValidator

protected final com.hpe.caf.worker.testing.validation.ValuePropertyValidator simpleValueValidator

Constructor Detail

DocumentWorkerFieldValueValidator

public DocumentWorkerFieldValueValidator(com.hpe.caf.api.worker.DataStore dataStore,
                                         com.hpe.caf.worker.testing.TestConfiguration testConfiguration,
                                         com.hpe.caf.api.Codec codec,
                                         String... recognizedPropertyNames)

Constructs a validator that validates DocumentWorkerFieldValue instances of specific named fields

Parameters:

dataStore - the data store from which storage reference field values will be retrieved for validation

testConfiguration - various settings controlling testing

codec - the codec to be used when validating storage reference values

recognizedPropertyNames - the names of the DocumentWorkerFieldValue fields that are validated by this validator instance; may be null, in which case the validator may be used to validate any DocumentWorkerFieldValue field

Method Detail

canValidate

public boolean canValidate(String propertyName,
                           Object sourcePropertyValue,
                           Object validatorPropertyValue)

Specified by:

canValidate in class com.hpe.caf.worker.testing.validation.CustomPropertyValidator

isValid

protected boolean isValid(Object testedPropertyValue,
                          Object validatorPropertyValue)

Specified by:

isValid in class com.hpe.caf.worker.testing.validation.PropertyValidator

equal

protected boolean equal(DocumentWorkerFieldValue actual,
                        DocumentWorkerFieldValueExpectation expected)
                 throws com.hpe.caf.api.worker.DataStoreException,
                        IOException

Compares a DocumentWorkerFieldValue with an expected value and indicates if they can be considered equal.

Parameters:

actual - the document worker field value to check.

expected - expectation that the document worker field value should meet to be considered equal.

Returns:

whether the actual field value matched the expectation.

Throws:

com.hpe.caf.api.worker.DataStoreException - if there is a failure retrieving the field value from data store.

IOException - if there is a failure marshalling field value to bytes for comparison.

getReferencedData

protected com.hpe.caf.util.ref.ReferencedData getReferencedData(DocumentWorkerFieldValue actual)
                                                         throws com.hpe.caf.api.worker.DataStoreException,
                                                                IOException

Retrieves ReferencedData object for data on provided DocumentWorkerFieldValue.

Parameters:

actual - DocumentWorkerFieldValue to get ReferencedData for.

Returns:

ReferencedData representation of data on actual.

Throws:

com.hpe.caf.api.worker.DataStoreException - if there is a failure retrieving data from data store when setting on ReferencedData object.

IOException - if there is a failure marshalling field value to bytes.

getBytes

protected byte[] getBytes(DocumentWorkerFieldValue value)
                   throws com.hpe.caf.api.worker.DataStoreException,
                          IOException

Returns byte array representation of data on provided value.

Parameters:

value - field value to convert data for.

Returns:

byte array representation of data on passed field value. If data was a storage reference the actual data will have been retrieved from storage and converted to byte array.

Throws:

com.hpe.caf.api.worker.DataStoreException - if there is a failure retrieving data from data store when setting on ReferencedData object.

IOException - if there is a failure marshalling field value to bytes.

nullToEmpty

protected static String nullToEmpty(String str)

Returns an empty String if str is null otherwise returns str.

Parameters:

str - value to check for null and potentially return.

Returns:

empty string if str was null otherwise str unchanged.

nullToUtf8

protected static DocumentWorkerFieldEncoding nullToUtf8(DocumentWorkerFieldEncoding encoding)

Returns encoding as utf8 if encoding provided is null otherwise returns encoding.

Parameters:

encoding - value to check for null and potentially return.

Returns:

if encoding is null then DocumentWorkerFieldEncoding.utf8 or encoding if it was not null.