org.adroitlogic.x.base.util

Class ElementValidationHelper

java.lang.Object

org.adroitlogic.x.base.util.ElementValidationHelper

Direct Known Subclasses:

ConnectorOperationValidationHelper, ProcessingElementValidationHelper

public abstract class ElementValidationHelper
extends Object

Helper utility abstraction for field-level validation of a single flow element. This class accepts the parent XProcessingElement entity being validated, along with the FlowValidationResultFactory used for validation, the input parameter map and the destination list of FlowValidationResults, and populates the said list with results of different validation invocations.

Since:

17.07.2

Author:

Janaka Bandara

Field Summary

Fields

Modifier and Type	Field and Description
(package private) XProcessingElement	element
(package private) FlowValidationResultFactory	factory
(package private) Map<String,Object>	params cache for parameters extracted from the element being validated
(package private) List<FlowValidationResult>	results

Constructor Summary

Constructors

Constructor and Description
ElementValidationHelper(XProcessingElement element, List<FlowValidationResult> results, FlowValidationResultFactory factory) Creates a new helper (wrapper) for validating a given element

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,Object>	extractParameters() Helpers should implement this method to return parameters extracted from the entity being validated
String	getField(String fieldName) Returns the string value of a given field
<T> T	getField(String fieldName, Class<T> type) Returns value of a given field under an expected type
boolean	validateBoolean(String fieldName, boolean required, String displayName) Validates a field that expects a boolean value
boolean	validateBoolean(String fieldName, String displayName) Validates a required field that expects a boolean value
boolean	validateEmailAddress(String fieldName, boolean required, String displayName) Validates a field expecting an email addresses
boolean	validateEmailList(String fieldName, boolean required, String displayName) Validates a field expecting a list of comma-separated email addresses
<T> boolean	validateEnum(String fieldName, Class<T> enumType, String displayName) Validates a field that expects an enum value
boolean	validateNonEmptyString(String fieldName, boolean required, String displayName) Validates a field expecting a non-empty string
boolean	validateNonEmptyString(String fieldName, String displayName) Validates a required field expecting a non-empty string
boolean	validateNonNegativeInteger(String fieldName, boolean required, String displayName) Validates a field that expects a non-negative integer
boolean	validateNonNegativeInteger(String fieldName, String displayName) Validates a required field that expects a non-negative integer
boolean	validatePositiveInteger(String fieldName, boolean required, String displayName) Validates a field that expects a positive integer
boolean	validatePositiveInteger(String fieldName, String displayName) Validates a required field that expects a positive integer
boolean	validatePositiveLong(String fieldName, boolean required, String displayName) Validates a field that expects a positive long value
boolean	validatePositiveLong(String fieldName, String displayName) Validates a required field that expects a positive long value

Methods inherited from class java.lang.Object

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

Field Detail

element

final XProcessingElement element

results

final List<FlowValidationResult> results

factory

final FlowValidationResultFactory factory

params

Map<String,Object> params

cache for parameters extracted from the element being validated

Constructor Detail

ElementValidationHelper

public ElementValidationHelper(XProcessingElement element,
                               List<FlowValidationResult> results,
                               FlowValidationResultFactory factory)

Creates a new helper (wrapper) for validating a given element

Parameters:

element - the XProcessingElement to be validated

results - the List of FlowValidationResults where validation results should be stored

factory - the FlowValidationResultFactory for generating FlowValidationResult entities

Method Detail

validateBoolean

public boolean validateBoolean(String fieldName,
                               String displayName)

Validates a required field that expects a boolean value

Parameters:

fieldName - name of the field

displayName - name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateBoolean

public boolean validateBoolean(String fieldName,
                               boolean required,
                               String displayName)

Validates a field that expects a boolean value

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateEnum

public <T> boolean validateEnum(String fieldName,
                                Class<T> enumType,
                                String displayName)

Validates a field that expects an enum value

Type Parameters:

T - the type of the enum

Parameters:

fieldName - name of the field

enumType - expected type of the assigned enum value

displayName - name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateNonNegativeInteger

public boolean validateNonNegativeInteger(String fieldName,
                                          String displayName)

Validates a required field that expects a non-negative integer

Parameters:

fieldName - name of the field

displayName - name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateNonNegativeInteger

public boolean validateNonNegativeInteger(String fieldName,
                                          boolean required,
                                          String displayName)

Validates a field that expects a non-negative integer

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validatePositiveInteger

public boolean validatePositiveInteger(String fieldName,
                                       String displayName)

Validates a required field that expects a positive integer

Parameters:

fieldName - name of the field

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validatePositiveInteger

public boolean validatePositiveInteger(String fieldName,
                                       boolean required,
                                       String displayName)

Validates a field that expects a positive integer

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validatePositiveLong

public boolean validatePositiveLong(String fieldName,
                                    String displayName)

Validates a required field that expects a positive long value

Parameters:

fieldName - name of the field

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validatePositiveLong

public boolean validatePositiveLong(String fieldName,
                                    boolean required,
                                    String displayName)

Validates a field that expects a positive long value

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateEmailList

public boolean validateEmailList(String fieldName,
                                 boolean required,
                                 String displayName)

Validates a field expecting a list of comma-separated email addresses

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateEmailAddress

public boolean validateEmailAddress(String fieldName,
                                    boolean required,
                                    String displayName)

Validates a field expecting an email addresses

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateNonEmptyString

public boolean validateNonEmptyString(String fieldName,
                                      String displayName)

Validates a required field expecting a non-empty string

Parameters:

fieldName - name of the field

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

validateNonEmptyString

public boolean validateNonEmptyString(String fieldName,
                                      boolean required,
                                      String displayName)

Validates a field expecting a non-empty string

Parameters:

fieldName - name of the field

required - true if the field is a required one, false otherwise

displayName - the name to be displayed in the validation result

Returns:

true if the field value exists and is valid, false otherwise

getField

public <T> T getField(String fieldName,
                      Class<T> type)

Returns value of a given field under an expected type

Type Parameters:

T - type of the expected return value

Parameters:

fieldName - name of the field

type - Class of the expected type

Returns:

value of the field fieldName as an instance of type

Throws:

ClassCastException - if the type conversion fails

getField

public String getField(String fieldName)

Returns the string value of a given field

Parameters:

fieldName - name of the field

Returns:

value of the field fieldName as a string

Throws:

ClassCastException - if the field is not of String type

extractParameters

protected abstract Map<String,Object> extractParameters()

Helpers should implement this method to return parameters extracted from the entity being validated

Returns:

the extracted Map of parameters from the validated entity