atg.service.validator

Class MapUpdatingValidator<V>

java.lang.Object

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

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

atg.service.validator.Validators.RequiredValidator<java.util.Map<java.lang.String,V>>

atg.service.validator.Validators.MapValidator<V>

atg.service.validator.MapUpdatingValidator<V>

All Implemented Interfaces:

BeanValidator, atg.service.validator.ChildValidator<java.util.Map<java.lang.String,V>>, ConfigurableValidator<java.util.Map<java.lang.String,V>>, Parentable, ParentValidator<java.util.Map<java.lang.String,V>>, atg.service.validator.RegistryAwareValidator<java.util.Map<java.lang.String,V>>, UpdatingValidator<java.util.Map<java.lang.String,V>>, Validator<java.util.Map<java.lang.String,V>>

public class MapUpdatingValidator<V>
extends Validators.MapValidator<V>
implements UpdatingValidator<java.util.Map<java.lang.String,V>>, BeanValidator, atg.service.validator.RegistryAwareValidator<java.util.Map<java.lang.String,V>>

An UpdatingValidator that synchronizes maps. Assumes that the may values are effectively homogenous. For heterogenous maps, either use a generic ValidatorManagerValidator or a custom UpdatingValidator.

This class makes the following assumptions:

• Map keys are always strings (as with GSA map properties).
• Map values will not be null.

Created: August 14 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
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
MapUpdatingValidator() Create a new instance.
MapUpdatingValidator(boolean pRequired) Create a new instance.
MapUpdatingValidator(boolean pRequired, Validator<? extends V> pValueValidator) Create a new instance.
MapUpdatingValidator(java.lang.String pErrorCode, boolean pRequired) Create a new instance.
MapUpdatingValidator(java.lang.String pErrorCode, boolean pRequired, Validator<? extends V> pValueValidator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected MapUpdateHelper	createDefaultMapUpdateHelper()
protected boolean	createEquivalentAlsoAdds(java.lang.Object pTargetMap, ValidatorContext<?> pContext) Return whether creation a matching target also adds to the collection.&= This method is needed because we delay adding values to the map until after the element is processed.
protected V	createEquivalentForMap(java.lang.String pKey, java.lang.Object pSourceValue, java.lang.Object pMapDst, ValidatorContext<?> pContext) Get/create an equivalent object for the value map.
protected java.lang.Object	createMapDestination(java.lang.String pPropertyName, java.lang.Object pTarget, ValidatorContext<?> pContext) If the Map on the on the target bean is null, this method will be invoked.
atg.service.validator.BeanValidatorRegistry	getBeanValidatorRegistry()
atg.service.validator.BeanValidatorRegistry	getRegistry() Returns property registry.
java.lang.Class	getTargetBeanValueCreateType() Returns property targetBeanValueCreateType.
java.lang.Class	getTargetMapCreateType() Returns property targetMapCreateType.
MapUpdateHelper<?,V>	getUpdateHelper() Returns property updateHelper.
boolean	isAutoCreateMapTargetGuess() Returns property autoCreateMapTargetGuess.
protected void	putNewTargetValue(java.lang.Object pTargetMap, java.lang.String pKey, java.lang.Object pTargetValue, ValidatorContext<?> pContext) Add a put a target value to the target map.
protected void	removeKeyFromMap(java.lang.String pKey, java.lang.Object pMapDst, ValidatorContext<?> pContext) Remove the key pKey from the map pMapDst.
void	setAutoCreateMapTargetGuess(boolean pAutoCreateMapTargetGuess) Sets property autoCreateMapTargetGuess.
void	setBeanValidatorRegistry(atg.service.validator.BeanValidatorRegistry pRegistry)
void	setRegistry(atg.service.validator.BeanValidatorRegistry pRegistry) Sets property registry.
void	setTargetBeanValueCreateType(java.lang.Class pTargetBeanValueCreateType) Sets property targetBeanValueCreateType.
void	setTargetMapCreateType(java.lang.Class pTargetMapCreateType) Sets property targetMapCreateType.
void	setUpdateHelper(MapUpdateHelper<?,V> pUpdateHelper) Sets property updateHelper.
protected boolean	shouldSetCreatedMapAsProperty(java.lang.Object pTargetMap, ValidatorContext<?> pContext) Return whether to set the created map as a property of the parent.
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 pSource, java.lang.Object pTarget, ValidatorContext<?> pContext) Typically invoked by ValidatorManager.
void	validateBean(java.lang.Object pBean, ValidatorContext<?> pContext) Validate the specified bean.

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

getChildValidatorMap, getChildValidators, getDefaultKeyForChildValidatorMap, setChildValidatorMap, setKeyValidator, setValueValidator, validateValue

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

getClassesRequired, getClassRequired, getRequiredOption, getRequiredPredicate, isRequired, isSourceOnly, keyMustBePresent, setClassesRequired, setClassRequired, setRequired, setRequiredOption, setRequiredPredicate, setSourceOnly

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

assertAlphanumeric, assertBoolean, assertDateTime, assertDouble, assertInstanceOf, assertInstanceOf, assertInteger, assertInteger, assertLong, assertNotBlankString, assertNotEmpty, assertNotEmpty, assertNotNull, assertNotNull, assertString, assertString, assertString, assertUnicodeAlphanumeric, createInstance, createInstance, getBeanPropertyValueForValidation, getCheckedBeanPropertyValueForValidation, getErrorCode, getNameForClass, getNameForClasses, getParentValidator, getPropertyNames, getPropertyValue, getPropertyValue, hasProperty, isDigits, isRequired, setErrorCode, setParentValidator, 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, validateValue

Methods inherited from interface atg.service.validator.ConfigurableValidator

getErrorCode, setErrorCode

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

LOGGER

protected static final VariableArgumentApplicationLogging LOGGER

Constructor Detail

MapUpdatingValidator

public MapUpdatingValidator()

Create a new instance.

MapUpdatingValidator

public MapUpdatingValidator(boolean pRequired)

Create a new instance.

Parameters:

pRequired - whether or not a non-null value is required.

MapUpdatingValidator

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

Create a new instance.

Parameters:

pRequired - whether or not a non-null value is required.

pValueValidator - the validator to use to validate the values (rather than the keys) of the map.

MapUpdatingValidator

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

Create a new instance.

Parameters:

pErrorCode - the string error code to report on CCExceptions created by this validator.

pRequired - whether or not a non-null value is required.

MapUpdatingValidator

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

Create a new instance.

Parameters:

pErrorCode - the string error code to report on CCExceptions created by this validator.

pRequired - whether or not a non-null value is required.

pValueValidator - the validator to use to validate the values (rather than the keys) of the map.

Method Detail

setAutoCreateMapTargetGuess

public void setAutoCreateMapTargetGuess(boolean pAutoCreateMapTargetGuess)

Sets property autoCreateMapTargetGuess. Whether to auto-create a target collection if none exists, guessing based on the type of the parent.

isAutoCreateMapTargetGuess

public boolean isAutoCreateMapTargetGuess()

Returns property autoCreateMapTargetGuess. Whether to auto-create a target collection if none exists, guessing based on the type of the parent.

setRegistry

public void setRegistry(atg.service.validator.BeanValidatorRegistry pRegistry)

Sets property registry. Our payload schema registry.

getRegistry

public atg.service.validator.BeanValidatorRegistry getRegistry()

Returns property registry. Our payload schema registry.

setBeanValidatorRegistry

public void setBeanValidatorRegistry(atg.service.validator.BeanValidatorRegistry pRegistry)

Specified by:

setBeanValidatorRegistry in interface atg.service.validator.RegistryAwareValidator<java.util.Map<java.lang.String,V>>

getBeanValidatorRegistry

public atg.service.validator.BeanValidatorRegistry getBeanValidatorRegistry()

Specified by:

getBeanValidatorRegistry in interface atg.service.validator.RegistryAwareValidator<java.util.Map<java.lang.String,V>>

setTargetMapCreateType

public void setTargetMapCreateType(java.lang.Class pTargetMapCreateType)

Sets property targetMapCreateType. The type of map/object to create on the target, if one does not exists. A null value means do not attempt to create a target map/object, unless autoCreateMapTargetGuess is true.

getTargetMapCreateType

public java.lang.Class getTargetMapCreateType()

Returns property targetMapCreateType. The type of map/object to create on the target, if one does not exists. A null value means do not attempt to create a target map/object, unless autoCreateMapTargetGuess is true.

setTargetBeanValueCreateType

public void setTargetBeanValueCreateType(java.lang.Class pTargetBeanValueCreateType)

Sets property targetBeanValueCreateType. The type of the target bean value to create. If null, only handles primitives.

getTargetBeanValueCreateType

public java.lang.Class getTargetBeanValueCreateType()

Returns property targetBeanValueCreateType. The type of the target bean value (for values in the map) to create. If null, only handles primitives.

setUpdateHelper

public void setUpdateHelper(MapUpdateHelper<?,V> pUpdateHelper)

Sets property updateHelper. The update helper to use for creating the target Map, creating values in the map, etc.

getUpdateHelper

public MapUpdateHelper<?,V> getUpdateHelper()

Returns property updateHelper. The update helper to use for creating the target Map, creating values in the map, etc.

Returns:

the update helper.

updateBeanValue

public UpdatingValidator.PropertyUpdateAction updateBeanValue(java.lang.String pPropertyName,
                                                              java.lang.Object pSource,
                                                              java.lang.Object pTarget,
                                                              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<java.util.Map<java.lang.String,V>>

pSource - the value of pPropertyName property of the source bean

pTarget - 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.

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.

createMapDestination

protected java.lang.Object createMapDestination(java.lang.String pPropertyName,
                                                java.lang.Object pTarget,
                                                ValidatorContext<?> pContext)

If the Map on the on the target bean is null, this method will be invoked. If a null is returned, than no target map will be updated.

Parameters:

pPropertyName - the property name being created

pTarget - the target bean.

pContext - the update context.

Returns:

the created map destination, or null.

createEquivalentForMap

protected V createEquivalentForMap(java.lang.String pKey,
                                   java.lang.Object pSourceValue,
                                   java.lang.Object pMapDst,
                                   ValidatorContext<?> pContext)

Get/create an equivalent object for the value map.

Parameters:

pKey - the map key to create a value for.

pSourceValue - the value for the key in the source map.

pMapDst - the target map into which the returned object will be placed.

pContext - the update context.

Returns:

the created object, or null.

removeKeyFromMap

protected void removeKeyFromMap(java.lang.String pKey,
                                java.lang.Object pMapDst,
                                ValidatorContext<?> pContext)
                         throws PropertyNotFoundException

Remove the key pKey from the map pMapDst. Default implementation simply calles pMapDst.remove(pKey), but subclasses can override if extra (or different) processing is needed to remove the map entry and dispose of the associated value object.

Parameters:

pKey - the key to remove from the map

pMapDst - the destination map from which to remove the key

pContext - the current update context.

Throws:

PropertyNotFoundException

createEquivalentAlsoAdds

protected boolean createEquivalentAlsoAdds(java.lang.Object pTargetMap,
                                           ValidatorContext<?> pContext)

Return whether creation a matching target also adds to the collection.&= This method is needed because we delay adding values to the map until after the element is processed.

Parameters:

pTargetMap - the target map.

pContext - the update context.

Returns:

true if createEquivalentForMap also adds the returned value to the map, false otherwise.

shouldSetCreatedMapAsProperty

protected boolean shouldSetCreatedMapAsProperty(java.lang.Object pTargetMap,
                                                ValidatorContext<?> pContext)

Return whether to set the created map as a property of the parent. Default implementation returns true.

Parameters:

pContext - the update context.

Returns:

true if a created map should be set as a property on the owning target bean.

putNewTargetValue

protected void putNewTargetValue(java.lang.Object pTargetMap,
                                 java.lang.String pKey,
                                 java.lang.Object pTargetValue,
                                 ValidatorContext<?> pContext)
                          throws PropertyNotFoundException

Add a put a target value to the target map. Default implementation just does an put. Some implementers may need to displose/unlinnk the old key, or call other code to add to the map.

Parameters:

pTargetMap - the map to add the value to.

pKey - the key to add to the target map.

pTargetValue - the new value to add to the map.

pContext - the update context.

Throws:

PropertyNotFoundException

createDefaultMapUpdateHelper

protected MapUpdateHelper createDefaultMapUpdateHelper()