atg.service.validator

Class SwitchingUpdatingValidator<T>

java.lang.Object

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

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

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

atg.service.validator.SwitchingUpdatingValidator<T>

Type Parameters:

T - the (super-)type of the objects to being validated.

All Implemented Interfaces:

AdditionalAllowedPropertiesProvider, BeanValidator, Parentable, ParentValidator<T>, UpdatingValidator<T>, Validator<T>

public class SwitchingUpdatingValidator<T>
extends Validators.RequiredValidator<T>
implements UpdatingValidator<T>, ParentValidator<T>, BeanValidator, AdditionalAllowedPropertiesProvider

A validator class delegates to more specific validators based on the typing/switching property value. This is useful for dealing with sub-typing (either for java beans or repository items).

Note that while this class implements BeanValidator, successfully invoking validateBean() or updateBean() requires that the direct child validators implement BeanValidator, or are an instance of ValidatorManager.ValidatorManagerValidator.

Created: September 22 2014

Nested Class Summary

Nested classes/interfaces inherited from interface atg.service.validator.UpdatingValidator

UpdatingValidator.NoOpValidator<T>, UpdatingValidator.NullObjectIfNulledUpdatingValidator, UpdatingValidator.PropertyUpdateAction

Nested classes/interfaces inherited from interface atg.service.validator.BeanValidator

BeanValidator.NoOpBeanValidator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	DEFAULT_OPTION_KEY Our default option.
protected static VariableArgumentApplicationLogging	LOGGER

Fields inherited from interface atg.service.validator.UpdatingValidator

NO_OP

Fields inherited from interface atg.service.validator.BeanValidator

NO_OP_BEAN_VALIDATOR

Constructor Summary

Constructors

Constructor and Description
SwitchingUpdatingValidator()
SwitchingUpdatingValidator(java.lang.String pErrorCode, boolean pRequired, java.lang.String pSwitchingPropertyName, java.util.Map<?,Validator<? extends T>> pSwitchValueToValidator, Validator<? extends T> pDefaultValidator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	createInstanceOrUpdateType(java.lang.Object pTypeValue, java.lang.String pPropertyName, java.lang.Object pSourceValue, java.lang.Object pTargetValue, ValidatorContext<?> pContext) Create or replace pTargetValue.
boolean	getAddCreatedBeanToTarget() Returns property addCreatedBeanToTarget.
java.util.Set<java.lang.String>	getAdditionalAllowedProperties(java.lang.Object pSource, java.lang.Object pTarget, ValidatorContext<?> pContext) Return any additional allowed properties.
protected BeanValidator	getBeanValidatorForValidator(Validator<?> pValidator) Get the bean validator for the specified validator.
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.
Validator<? extends T>	getDefaultValidator() Returns property defaultValidator.
java.util.Map<java.lang.Object,java.util.Set<java.lang.String>>	getOptionToAdditionalAllowedProperties() Returns property optionToAdditionalAllowedProperties.
java.lang.String	getSwitchingPropertyName() Returns property switchingPropertyName.
protected java.lang.Object	getSwitchingValue(java.lang.Object pBean, ValidatorContext<?> pContext) Get the switching value from pBean.
java.util.Map<?,Validator<? extends T>>	getSwitchValueToValidatorMap() Get the switch value to validator map.
protected Validator<? extends T>	getValidatorForBean(java.lang.Object pSourceBean, java.lang.Object pTargetBean, java.lang.String pPropertyName, ValidatorContext<?> pContext) Get the appropriate validator for the specified bean.
atg.service.validator.GenericUpdatingValidatorHelper	getValidatorHelper() Returns property validatorHelper.
UpdatingValidator.PropertyUpdateAction	handleTargetDeletion(java.lang.String pPropertyName, java.lang.Object pSourceValue, java.lang.Object pTargetValue, ValidatorContext<?> pContext)
boolean	isAllowTypeChange() Returns property allowTypeChange.
boolean	isAllowUnknownTypes() Returns property allowUnknownTypes.
void	setAddCreatedBeanToTarget(boolean pAddCreatedBeanToTarget) Sets property addCreatedBeanToTarget.
void	setAllowTypeChange(boolean pAllowTypeChange) Sets property allowTypeChange.
void	setAllowUnknownTypes(boolean pAllowUnknownTypes) Sets property allowUnknownTypes.
void	setChildValidatorMap(java.util.Map<?,Validator<?>> pChildMap) Set the child validator map.
void	setDefaultValidator(Validator<? extends T> pDefaultValidator) Sets property defaultValidator.
void	setOptionToAdditionalAllowedProperties(java.util.Map<java.lang.Object,java.util.Set<java.lang.String>> pOptionToAdditionalAllowedProperties) Sets property optionToAdditionalAllowedProperties.
void	setSwitchingPropertyName(java.lang.String pSwitchingPropertyName) Sets property switchingPropertyName.
void	setSwitchValueToValidatorMap(java.util.Map<?,Validator<? extends T>> pSwitchValueToValidatorMap) Set the switch value to validator map.
void	setValidatorHelper(atg.service.validator.GenericUpdatingValidatorHelper pUpdateHelper) Sets property validatorHelper.
void	updateBean(java.lang.Object pSource, java.lang.Object pTarget, ValidatorContext<?> pContext) Update the target bean with properties from pSource.
UpdatingValidator.PropertyUpdateAction	updateBeanValue(java.lang.String pPropertyName, java.lang.Object pSourceValue, java.lang.Object pTargetValue, ValidatorContext<?> pContext) Typically invoked by ValidatorManager.
void	validateBean(java.lang.Object pBean, ValidatorContext<?> pContext) Validate the specified bean.
T	validateBeanProperty(java.lang.String pPropertyName, java.lang.Object pBean, ValidatorContext<?> pContext) Validate a property of the bean pPropertyValue.
T	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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

DEFAULT_OPTION_KEY

public static final java.lang.String DEFAULT_OPTION_KEY

Our default option.

See Also:

Constant Field Values

LOGGER

protected static final VariableArgumentApplicationLogging LOGGER

Constructor Detail

SwitchingUpdatingValidator

public SwitchingUpdatingValidator(java.lang.String pErrorCode,
                                  boolean pRequired,
                                  java.lang.String pSwitchingPropertyName,
                                  java.util.Map<?,Validator<? extends T>> pSwitchValueToValidator,
                                  Validator<? extends T> pDefaultValidator)

Create a new instance.

Parameters:

pPropertyName - the switching property name to switch one

SwitchingUpdatingValidator

public SwitchingUpdatingValidator()

Method Detail

setOptionToAdditionalAllowedProperties

public void setOptionToAdditionalAllowedProperties(java.util.Map<java.lang.Object,java.util.Set<java.lang.String>> pOptionToAdditionalAllowedProperties)

Sets property optionToAdditionalAllowedProperties. Maps from options to additional allowed properties.

getOptionToAdditionalAllowedProperties

public java.util.Map<java.lang.Object,java.util.Set<java.lang.String>> getOptionToAdditionalAllowedProperties()

Returns property optionToAdditionalAllowedProperties. Maps from options to additional allowed properties.

setAllowTypeChange

public void setAllowTypeChange(boolean pAllowTypeChange)

Sets property allowTypeChange. Whether to allow the type change property to be set.

isAllowTypeChange

public boolean isAllowTypeChange()

Returns property allowTypeChange. Whether to allow the type change property to be set.

setAllowUnknownTypes

public void setAllowUnknownTypes(boolean pAllowUnknownTypes)

Sets property allowUnknownTypes. Whether to allow unknown types. This property only has effect if there is no default validator specified.

isAllowUnknownTypes

public boolean isAllowUnknownTypes()

Returns property allowUnknownTypes. Whether to allow unknown types. This property only has effect if there is no default validator specified.

getSwitchValueToValidatorMap

public java.util.Map<?,Validator<? extends T>> getSwitchValueToValidatorMap()

Get the switch value to validator map.

setSwitchValueToValidatorMap

public void setSwitchValueToValidatorMap(java.util.Map<?,Validator<? extends T>> pSwitchValueToValidatorMap)

Set the switch value to validator map.

setSwitchingPropertyName

public void setSwitchingPropertyName(java.lang.String pSwitchingPropertyName)

Sets property switchingPropertyName. The name of our switch property.

getSwitchingPropertyName

public java.lang.String getSwitchingPropertyName()

Returns property switchingPropertyName. The name of our switch property.

setDefaultValidator

public void setDefaultValidator(Validator<? extends T> pDefaultValidator)

Sets property defaultValidator. The default validator.

getDefaultValidator

public Validator<? extends T> getDefaultValidator()

Returns property defaultValidator. The default validator.

setValidatorHelper

public void setValidatorHelper(atg.service.validator.GenericUpdatingValidatorHelper pUpdateHelper)

Sets property validatorHelper. The helper to use for creating the target beans etc.

getValidatorHelper

public atg.service.validator.GenericUpdatingValidatorHelper getValidatorHelper()

Returns property validatorHelper. The helper to use for creating the target beans etc.

setAddCreatedBeanToTarget

public void setAddCreatedBeanToTarget(boolean pAddCreatedBeanToTarget)

Sets property addCreatedBeanToTarget.

getAddCreatedBeanToTarget

public boolean getAddCreatedBeanToTarget()

Returns property addCreatedBeanToTarget.

getSwitchingValue

protected java.lang.Object getSwitchingValue(java.lang.Object pBean,
                                             ValidatorContext<?> pContext)
                                      throws PropertyNotFoundException

Get the switching value from pBean.

Parameters:

pBean - the object to get the switching value from.

pContext - the update context

Throws:

PropertyNotFoundException

validateValue

public T 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<T>

Overrides:

validateValue in class Validators.RequiredValidator<T>

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.

updateBeanValue

public UpdatingValidator.PropertyUpdateAction updateBeanValue(java.lang.String pPropertyName,
                                                              java.lang.Object pSourceValue,
                                                              java.lang.Object pTargetValue,
                                                              ValidatorContext<?> pContext)

Description copied from interface: UpdatingValidator

Typically invoked by ValidatorManager. Update a bean value from a source value. Note that if a new target bean is created, pContext.replaceParentDst() may need to be invoked.

Specified by:

updateBeanValue in interface UpdatingValidator<T>

pSourceValue - the value of pPropertyName property of the source bean

pTargetValue - the existing value of pPropertyName of the target bean

pContext - the current update context (with the current source/target parent beans).

Returns:

return a PropertyUpdateAction which the validator should take.

validateBeanProperty

public T validateBeanProperty(java.lang.String pPropertyName,
                              java.lang.Object pBean,
                              ValidatorContext<?> pContext)

Description copied from class: Validators.ValidatorImpl

Validate a property of the bean pPropertyValue.

Specified by:

validateBeanProperty in interface Validator<T>

Overrides:

validateBeanProperty in class Validators.ValidatorImpl<T>

Parameters:

pPropertyName - the property of pBean to validate

pBean - the bean to fetch pPropertyName from and validate

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.

getValidatorForBean

protected Validator<? extends T> getValidatorForBean(java.lang.Object pSourceBean,
                                                     java.lang.Object pTargetBean,
                                                     java.lang.String pPropertyName,
                                                     ValidatorContext<?> pContext)

Get the appropriate validator for the specified bean. May return null.

Parameters:

pSourceBean - the source bean to get a validator for.

pTargetBean - the target bean to use if validator is null for source bean.

pPropertyName - the name of the property to switch on

pContext - the current validator context.

Returns:

the validator for the specified bean.

handleTargetDeletion

public UpdatingValidator.PropertyUpdateAction handleTargetDeletion(java.lang.String pPropertyName,
                                                                   java.lang.Object pSourceValue,
                                                                   java.lang.Object pTargetValue,
                                                                   ValidatorContext<?> pContext)

createInstanceOrUpdateType

protected java.lang.Object createInstanceOrUpdateType(java.lang.Object pTypeValue,
                                                      java.lang.String pPropertyName,
                                                      java.lang.Object pSourceValue,
                                                      java.lang.Object pTargetValue,
                                                      ValidatorContext<?> pContext)

Create or replace pTargetValue. The base implementation just sets the switchingProperty to pTypeValue, and returns null if

Parameters:

pTypeValue - the type-determining value

pPropertyName - the property name

pSourceValue - the source value

pTargetValue - the target value

pContext - the update context

Returns:

the created value (in thise case, just pTargetValue or null).

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)

Set the child validator map. May throw

Specified by:

setChildValidatorMap in interface Parentable

Parameters:

pChildMap - the child validator map.

Throws:

OperationNotSupportedException - if not supported.

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.

getBeanValidatorForValidator

protected BeanValidator getBeanValidatorForValidator(Validator<?> pValidator)

Get the bean validator for the specified validator. Currently, pValidator must implement BeanValidator, or be an instance of ValidatorManagerValidator.

Returns:

the BeanValidator form of pValidator.

Throws:

java.lang.ClassCastException - if pValidator is neither

validateBean

public void validateBean(java.lang.Object pBean,
                         ValidatorContext<?> pContext)

Description copied from interface: BeanValidator

Validate the specified bean.

Specified by:

validateBean in interface BeanValidator

Parameters:

pBean - the bean to validate

pContext - the validator context to which any validation errors will be added.

updateBean

public void updateBean(java.lang.Object pSource,
                       java.lang.Object pTarget,
                       ValidatorContext<?> pContext)

Description copied from interface: BeanValidator

Update the target bean with properties from pSource.

Specified by:

updateBean in interface BeanValidator

Parameters:

pSource - the source bean

pTarget - the target bean

pContext - the validator context.

getAdditionalAllowedProperties

public java.util.Set<java.lang.String> getAdditionalAllowedProperties(java.lang.Object pSource,
                                                                      java.lang.Object pTarget,
                                                                      ValidatorContext<?> pContext)

Return any additional allowed properties. Return a set of allowed properties, or null.

Specified by:

getAdditionalAllowedProperties in interface AdditionalAllowedPropertiesProvider

Parameters:

pSource - the source object.

pTarget - the target object.

pContext - the validator context.

Returns:

a set of additional allowed properties, or null.