atg.service.validator

Class Validators.CollectionValidator<V,C extends java.util.Collection<? extends V>>

java.lang.Object

atg.service.validator.Validators.ValidatorImpl<T>

atg.service.validator.Validators.NonNullValidator<T>

atg.service.validator.Validators.RequiredValidator<C>

atg.service.validator.Validators.CollectionValidator<V,C>

All Implemented Interfaces:

Parentable, ParentValidator<C>, Validator<C>

Direct Known Subclasses:

UnorderedCollectionUpdatingValidator

Enclosing interface:

Validators

public static class Validators.CollectionValidator<V,C extends java.util.Collection<? extends V>>
extends Validators.RequiredValidator<C>
implements ParentValidator<C>

Field Summary

Fields inherited from interface atg.service.validator.ParentValidator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
CollectionValidator(boolean pRequired) Create a new instance.
CollectionValidator(boolean pRequired, Validator<? extends V> pValueValidator)
CollectionValidator(java.lang.String pErrorCode, boolean pRequired) Create a new instance.
CollectionValidator(java.lang.String pErrorCode, boolean pRequired, java.lang.Class<? extends C> pRequiredClass) Create a new instance.
CollectionValidator(java.lang.String pErrorCode, boolean pRequired, Validator<? extends V> pValueValidator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected C	checkUniquePropertyValues(java.lang.String pPropertyName, C pCollection, ValidatorContext<?> pContext) Check to make sure that any uniquePropertyNames have unique values for each of the elements of pCollection.
protected C	filterCollection(C pCollection, ValidatorContext<?> pContext) Filter pCollection, potentially returning a trimmed down copy of the collection.
java.util.Map<java.lang.Object,Validator<?>>	getChildValidatorMap() Return a map form of the child validators, used for generating a human readable representation of the parent-child relationship.
java.util.Collection<? extends Validator<?>>	getChildValidators() Get any child validators.
java.lang.Object	getDefaultKeyForChildValidatorMap() Return the default key for the childValidatorMap, if any.
java.lang.String[]	getUniquePropertyNames() Property names that must be unique among the child products.
Validator<? extends V>	getValueValidator() Return the value validator that validates individual members of our collection.
protected java.util.List<java.lang.Object>	listFromArray(java.lang.Object pArray) Create an array list from an array.
void	setChildValidatorMap(java.util.Map<?,Validator<?>> pChildMap) Set the child validator map.
C	validateValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue, ValidatorContext<?> pContext) Validate (and possibly convert) the specified property value.

Methods inherited from class atg.service.validator.Validators.RequiredValidator

getClassRequired, getRequiredOption, getRequiredPredicate, isRequired, keyMustBePresent, setClassRequired, setRequired, setRequiredOption, setRequiredPredicate

Methods inherited from class atg.service.validator.Validators.ValidatorImpl

assertAlphanumeric, assertBoolean, assertDateTime, assertDouble, assertInstanceOf, assertInteger, assertLong, assertNotBlankString, assertNotEmpty, assertNotEmpty, assertNotNull, assertNotNull, assertString, assertString, assertString, createInstance, getBeanPropertyValueForValidation, getErrorCode, getNameForClass, getPropertyNames, getPropertyValue, getPropertyValue, hasProperty, isDigits, isRequired, setErrorCode, setPropertyValue, validateBeanProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.service.validator.Validator

validateBeanProperty

Constructor Detail

CollectionValidator

public CollectionValidator(java.lang.String pErrorCode,
                           boolean pRequired)

Create a new instance.

Parameters:

pErrorCode - the error code to use.

pRequired - whether a non-null value is required.

CollectionValidator

public CollectionValidator(boolean pRequired)

Create a new instance.

Parameters:

pRequired - whether a non-null value is required.

CollectionValidator

public CollectionValidator(boolean pRequired,
                           Validator<? extends V> pValueValidator)

CollectionValidator

public CollectionValidator(java.lang.String pErrorCode,
                           boolean pRequired,
                           Validator<? extends V> pValueValidator)

Create a new instance.

Parameters:

pErrorCode - the error code to use.

pRequired - whether a non-null value is required.

pValueValidator - the validator to use for each value.

CollectionValidator

public CollectionValidator(java.lang.String pErrorCode,
                           boolean pRequired,
                           java.lang.Class<? extends C> pRequiredClass)

Create a new instance.

Parameters:

pErrorCode - the error code to use.

pRequired - whether a non-null value is required.

pRequiredClass - the required class for the collection.

Method Detail

getValueValidator

public Validator<? extends V> getValueValidator()

Return the value validator that validates individual members of our collection.

Returns:

the value validator

listFromArray

protected java.util.List<java.lang.Object> listFromArray(java.lang.Object pArray)

Create an array list from an array.

Parameters:

pArray - the

Returns:

the contents of pArray as an arraylist

validateValue

public C validateValue(java.lang.String pPropertyName,
                       java.lang.Object pPropertyValue,
                       ValidatorContext<?> pContext)

Description copied from interface: Validator

Validate (and possibly convert) the specified property value.

Specified by:

validateValue in interface Validator<C extends java.util.Collection<? extends V>>

Overrides:

validateValue in class Validators.RequiredValidator<C extends java.util.Collection<? extends V>>

Parameters:

pPropertyName - the name of the property being validated. This is typically used as a key for fetching the value from pProperties.

pPropertyValue - the fetched property value

pContext - the current validation context.

Returns:

the validated (and possibly converted) value. May return null for invalid property data. May return ValidatorConstants.NULL_OBJECT indicating the that target property should be updated to null.

filterCollection

protected C filterCollection(C pCollection,
                             ValidatorContext<?> pContext)

Filter pCollection, potentially returning a trimmed down copy of the collection. Default implementation just returns pCollection. Note that if a copy is returned and one is extending UnorderedCollectionUpdatingValidator, one must also override shouldSetCreatedCollectionAsProperty() to return false, and implement addNewTargetElement() and removeUnmatchedTargetValues() to update the original collection.

Parameters:

pCollection - the collection to be filtered or returned.

Returns:

a filtered copy of pCollection, or the original

getChildValidators

public java.util.Collection<? extends Validator<?>> getChildValidators()

Description copied from interface: Parentable

Get any child validators.

Specified by:

getChildValidators in interface Parentable

Returns:

the collection of child validators.

getChildValidatorMap

public java.util.Map<java.lang.Object,Validator<?>> getChildValidatorMap()

Description copied from interface: Parentable

Return a map form of the child validators, used for generating a human readable representation of the parent-child relationship. The keys might be property names (for ParentValidator), "*" for every child property or map element, or "[*]" for a validator that is applied to every elemen of a collection.

Specified by:

getChildValidatorMap in interface Parentable

setChildValidatorMap

public void setChildValidatorMap(java.util.Map<?,Validator<?>> pChildMap)

Description copied from interface: Parentable

Set the child validator map. May throw

Specified by:

setChildValidatorMap in interface Parentable

Parameters:

pChildMap - the child validator map.

getDefaultKeyForChildValidatorMap

public java.lang.Object getDefaultKeyForChildValidatorMap()

Description copied from interface: Parentable

Return the default key for the childValidatorMap, if any. The default key is used for validating values without an entry in the validator map.

Specified by:

getDefaultKeyForChildValidatorMap in interface Parentable

Returns:

the default key, or null if no default key is supported.

getUniquePropertyNames

public java.lang.String[] getUniquePropertyNames()

Property names that must be unique among the child products.

checkUniquePropertyValues

protected C checkUniquePropertyValues(java.lang.String pPropertyName,
                                      C pCollection,
                                      ValidatorContext<?> pContext)

Check to make sure that any uniquePropertyNames have unique values for each of the elements of pCollection.

Parameters:

pPropertyName - the name of the collection property being validated

pCollection - the actual collection being validated

pContext - the list of errors.

Returns:

pCollection if no errors were found. Otherwise, return null.