oracle.fmwplatform.envspec.validation.validators

Class ReferenceValidator

java.lang.Object

oracle.fmwplatform.util.validation.validators.BaseValidator

oracle.fmwplatform.envspec.validation.validators.ReferenceValidator

All Implemented Interfaces:

oracle.fmwplatform.util.validation.Validator

public class ReferenceValidator
extends oracle.fmwplatform.util.validation.validators.BaseValidator

Validates that a reference meets the naming requirements.

Since:

12.2.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREDENTIALS_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ReferenceValidator(oracle.fmwplatform.util.validation.Validate validate) Creates an instance of the ReferenceValidator associated to a particular Validate which is currently handling the validation processing.

Method Summary

Modifier and Type	Method and Description
void	init()
oracle.fmwplatform.util.validation.ValidationMessage	validate(Object element, Field field, Annotation validationAnnotation)
List<oracle.fmwplatform.util.validation.ValidationMessage>	validateCollection(Collection<Object> fieldCollection, Object element, Field field, Annotation validationAnnotation)
oracle.fmwplatform.util.validation.ValidationMessage	validateReference(Object element, Object fieldValue, String fieldName, boolean allowNull, ValidateReference.ReferenceType referenceType, String pattern, int min, int max) Validates that a reference meets the naming requirements.
List<oracle.fmwplatform.util.validation.ValidationMessage>	validateReferenceCollection(Collection<Object> fieldCollection, Object element, String fieldName, boolean allowNull, ValidateReference.ReferenceType referenceType, String pattern, int min, int max) Validates that the collection of references meets the naming requirements.

Methods inherited from class oracle.fmwplatform.util.validation.validators.BaseValidator

getExpectedFieldClass, getExpectedValidationAnnotationClass, getFieldName, getFieldName, getValidate, iterateCollection, setExpectedFieldClass, setExpectedValidationAnnotationClass, setValidate

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIALS_PROPERTY_NAME

public static final String CREDENTIALS_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

ReferenceValidator

public ReferenceValidator(oracle.fmwplatform.util.validation.Validate validate)

Creates an instance of the ReferenceValidator associated to a particular Validate which is currently handling the validation processing. This provides a context for the validation processing. where we can track messages amongst other things.

Parameters:

validate - the current Validate instance that is processing the validation

See Also:

for the detailed options

Method Detail

init

public void init()

Specified by:

init in class oracle.fmwplatform.util.validation.validators.BaseValidator

validate

public oracle.fmwplatform.util.validation.ValidationMessage validate(Object element,
                                                                     Field field,
                                                                     Annotation validationAnnotation)
                                                              throws IllegalArgumentException,
                                                                     IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException

validateCollection

public List<oracle.fmwplatform.util.validation.ValidationMessage> validateCollection(Collection<Object> fieldCollection,
                                                                                     Object element,
                                                                                     Field field,
                                                                                     Annotation validationAnnotation)
                                                                              throws IllegalArgumentException,
                                                                                     IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException

validateReferenceCollection

public List<oracle.fmwplatform.util.validation.ValidationMessage> validateReferenceCollection(Collection<Object> fieldCollection,
                                                                                              Object element,
                                                                                              String fieldName,
                                                                                              boolean allowNull,
                                                                                              ValidateReference.ReferenceType referenceType,
                                                                                              String pattern,
                                                                                              int min,
                                                                                              int max)

Validates that the collection of references meets the naming requirements.

Parameters:

fieldCollection - a collection of values within a field that are to be validated

element - the element containing the field to be validated

fieldName - the name of the field containing the collection

allowNull - whether a null is allowed for the value

referenceType - the Class type of the object that the reference refers to

pattern - regular expression that is to be used to determine the validity of the field. Predefined patterns are provided in this EnvSpecValidationExpressions handle common patterns.

min - the minimum length of the text defaulting to 0.

max - the maximum length of the text with -1 meaning that there is no maximum

Returns:

a list of messages that was produced during validation which can be an empty list

See Also:

EnvSpecValidationExpressions

validateReference

public oracle.fmwplatform.util.validation.ValidationMessage validateReference(Object element,
                                                                              Object fieldValue,
                                                                              String fieldName,
                                                                              boolean allowNull,
                                                                              ValidateReference.ReferenceType referenceType,
                                                                              String pattern,
                                                                              int min,
                                                                              int max)

Validates that a reference meets the naming requirements.

Parameters:

element - the element containing the field to be validate

fieldValue - the value from the field

fieldName - the name of the field containing the collection

allowNull - whether a null is allowed for the value

referenceType - the Class type of the object that the reference refers too

pattern - regular expression that is to be used to determine the validity of the field. Predefined patterns are provided in this class to handle common patterns.ed to the text value

min - the minimum length of the text defaulting to 0.

max - the maximum length of the text with -1 meaning that there is no maximum

Returns:

a ValidationMessage if one was created or null