atg.service.validator

Class UnorderedCollectionUpdatingValidator<E,C extends java.util.Collection<? extends E>>

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<E,C>

atg.service.validator.UnorderedCollectionUpdatingValidator<E,C>

Type Parameters:

E - the type of the elements in the source collection.

C - thed collection type.

All Implemented Interfaces:

BeanValidator, Parentable, ParentValidator<C>, UpdatingValidator<C>, Validator<C>

Direct Known Subclasses:

ListUpdatingValidator

public class UnorderedCollectionUpdatingValidator<E,C extends java.util.Collection<? extends E>>
extends Validators.CollectionValidator<E,C>
implements UpdatingValidator<C>, BeanValidator

An updating validator that attempts to sync two collections with one another. The collections themselves may be ordered (that is, a list), but order is deemed unimportant when synchronizing the two lists.

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

Method Summary

Modifier and Type	Method and Description
protected void	addNewTargetElement(java.util.Collection<java.lang.Object> pTargetCollection, java.lang.Object pTargetElement, ValidatorContext<?> pContext) Add a new target element to the target collection.
protected java.util.Collection<java.lang.Object>	createCollectionDestination(java.lang.String pPropertyName, java.lang.Object pTarget, ValidatorContext<?> pContext) If the pPropertyName on the target is null, this method will be invoked.
protected boolean	createMatchingTargetAlsoAdds(java.util.Collection<java.lang.Object> pTargetCollection, ValidatorContext<?> pContext) Return whether creation a matching target also adds to the collection.
protected java.lang.Object	createMatchingTargetElement(java.lang.String pPropertyName, int pSourceIndex, java.lang.Object pSourceElement, java.util.Collection<java.lang.Object> pTargetCollection, ValidatorContext<?> pContext) Create a matching target to be the target of properties of pSourceObject.
protected java.lang.Object	findMatchingTarget(java.lang.Object pSourceElement, java.util.Collection<java.lang.Object> pTargetCollection, ValidatorContext<?> pContext) Find a match for pSourceObject in the collection pTargetCollection.
protected java.util.List<atg.core.util.Pair.AliasedPair>	getMatchedPairs(C collSrc, java.util.List<java.lang.Object> dstsUnmatched, ValidatorContext pContext)
java.lang.Class	getTargetCollectionCreateType() Returns property targetCollectionCreateType.
java.lang.Class	getTargetElementCreateType() Returns property targetElementCreateType.
CollectionUpdateHelper<? extends java.util.Collection<?>,?>	getUpdateHelper() Returns property updateHelper.
boolean	isAutoCreateCollectionTargetGuess() Returns property autoCreateCollectionTargetGuess.
protected void	postProcessCollection(java.util.Collection<?> pTargetCollection, java.util.List<java.lang.Object> pDestinationItemsInSourceOrder, ValidatorContext<?> pContext) Post process the target collection, possibly ordering the target list.
protected void	removeUnmatchedTargetValues(java.util.Collection<java.lang.Object> pTargetCollection, java.util.List<java.lang.Object> pUnmatchedElements, ValidatorContext<?> pContext) Remove the unmatched element (pUnmatchedElements) from pTargetCollection.
void	setAutoCreateCollectionTargetGuess(boolean pAutoCreateCollectionTargetGuess) Sets property autoCreateCollectionTargetGuess.
void	setTargetCollectionCreateType(java.lang.Class pTargetCollectionCreateType) Sets property targetCollectionCreateType.
void	setTargetElementCreateType(java.lang.Class pTargetElementCreateType) Sets property targetElementCreateType.
void	setUpdateHelper(CollectionUpdateHelper<? extends java.util.Collection<?>,?> pUpdateHelper) Sets property updateHelper.
protected boolean	shouldPredeleteUnmatchedTargetValues(ValidatorContext<?> pContext) Whether to pre-delete unmatched target values.
protected boolean	shouldSetCreatedCollectionAsProperty(java.util.Collection<java.lang.Object> pTargetCollection, ValidatorContext<?> pContext) Return whether to set the created collection 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.CollectionValidator

checkUniquePropertyValues, filterCollection, getChildValidatorMap, getChildValidators, getDefaultKeyForChildValidatorMap, getUniquePropertyNames, getValueValidator, listFromArray, setChildValidatorMap, validateValue

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, validateValue

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

LOGGER

protected static final VariableArgumentApplicationLogging LOGGER

ID_PROPERTIES

public static final java.lang.String ID_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

UnorderedCollectionUpdatingValidator

public UnorderedCollectionUpdatingValidator()

Create a new instance. Defaults to not required, and validating a Collection class.

UnorderedCollectionUpdatingValidator

public UnorderedCollectionUpdatingValidator(boolean pRequired)

Create a new instance.

Parameters:

pRequired - whether a non-null value is required

UnorderedCollectionUpdatingValidator

public UnorderedCollectionUpdatingValidator(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 a non-null value is required

UnorderedCollectionUpdatingValidator

public UnorderedCollectionUpdatingValidator(boolean pRequired,
                                            Validator<? extends E> pValueValidator)

Create a new instance.

Parameters:

pRequired - whether a non-null value is required

pValueValidator - the validator for individual values.

UnorderedCollectionUpdatingValidator

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

Create a new instance.

Parameters:

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

pRequired - whether a non-null value is required

pValueValidator - the validator for individual values.

Method Detail

setAutoCreateCollectionTargetGuess

public void setAutoCreateCollectionTargetGuess(boolean pAutoCreateCollectionTargetGuess)

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

isAutoCreateCollectionTargetGuess

public boolean isAutoCreateCollectionTargetGuess()

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

setTargetCollectionCreateType

public void setTargetCollectionCreateType(java.lang.Class pTargetCollectionCreateType)

Sets property targetCollectionCreateType. The type of collection to create on the target bean, if no collection exists. If null, will attempt to guess a collection type based on the parent (if autoCreateCollectionTargetGuess is true).

getTargetCollectionCreateType

public java.lang.Class getTargetCollectionCreateType()

Returns property targetCollectionCreateType. The type of collection to create on the target bean, if no collection exists. If null, will attempt to guess a collection type based on the parent (if autoCreateCollectionTargetGuess is true).

setTargetElementCreateType

public void setTargetElementCreateType(java.lang.Class pTargetElementCreateType)

Sets property targetElementCreateType. The type of the target bean value (for elements in the collection) to create. If null, only handles primitives.

getTargetElementCreateType

public java.lang.Class getTargetElementCreateType()

Returns property targetElementCreateType. The type of the target bean value (for elements in the collection) to create. If null, only handles primitives.

setUpdateHelper

public void setUpdateHelper(CollectionUpdateHelper<? extends java.util.Collection<?>,?> pUpdateHelper)

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

getUpdateHelper

public CollectionUpdateHelper<? extends java.util.Collection<?>,?> getUpdateHelper()

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

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<C extends java.util.Collection<? extends E>>

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.

postProcessCollection

protected void postProcessCollection(java.util.Collection<?> pTargetCollection,
                                     java.util.List<java.lang.Object> pDestinationItemsInSourceOrder,
                                     ValidatorContext<?> pContext)

Post process the target collection, possibly ordering the target list. UnorderedCollectionUpdatingValidator does not do so, but subclasses may.

Parameters:

pTargetCollection - the target collection to post process. The target collection should be in its final state, except perhaps for ordering.

pDestinationItemsInSourceOrder - the destination items in source order. Should have the same members as pTargetCollection, but not necessary in source order.

pContext - the current validator context.

createCollectionDestination

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

If the pPropertyName on the target is null, this method will be invoked. If a null is returned, than no target collection will be updated.

Parameters:

pPropertyName - the parent property name.

pTarget - the owning target parent bean.

pContext - the owning validation context.

shouldPredeleteUnmatchedTargetValues

protected boolean shouldPredeleteUnmatchedTargetValues(ValidatorContext<?> pContext)

Whether to pre-delete unmatched target values.

Parameters:

pContext - the context to match

Returns:

true if unmatched targets should be predeleted, false otherwise.

shouldSetCreatedCollectionAsProperty

protected boolean shouldSetCreatedCollectionAsProperty(java.util.Collection<java.lang.Object> pTargetCollection,
                                                       ValidatorContext<?> pContext)

Return whether to set the created collection as a property of the parent.

Parameters:

pContext - the update context.

Returns:

true if the created collection would be set as a property on the source object/bean.

findMatchingTarget

protected java.lang.Object findMatchingTarget(java.lang.Object pSourceElement,
                                              java.util.Collection<java.lang.Object> pTargetCollection,
                                              ValidatorContext<?> pContext)
                                       throws PropertyNotFoundException,
                                              java.beans.IntrospectionException,
                                              atg.core.exception.ItemNotFoundException

Find a match for pSourceObject in the collection pTargetCollection. Default implemention uses equals to find a match.

Parameters:

pSourceElement - the source object to try to find a match for

pTargetCollection - the target collection

Returns:

the match element of the target collection, if a match is found. Otherwise, return null.

Throws:

atg.core.exception.ItemNotFoundException

PropertyNotFoundException

java.beans.IntrospectionException

createMatchingTargetElement

protected java.lang.Object createMatchingTargetElement(java.lang.String pPropertyName,
                                                       int pSourceIndex,
                                                       java.lang.Object pSourceElement,
                                                       java.util.Collection<java.lang.Object> pTargetCollection,
                                                       ValidatorContext<?> pContext)

Create a matching target to be the target of properties of pSourceObject. Default implementation returns pSourceElement if it is a primitive wrapper, or a String.

Parameters:

pSourceIndex - the source index

pSourceElement - the source element to create a match for

pTargetCollection - the collection into which pSourceElement should (eventually) be placed.

pContext - the update context.

Returns:

the newly created target, or null if one could not be created.

createMatchingTargetAlsoAdds

protected boolean createMatchingTargetAlsoAdds(java.util.Collection<java.lang.Object> pTargetCollection,
                                               ValidatorContext<?> pContext)

Return whether creation a matching target also adds to the collection.

Parameters:

pTargetCollection - the target collection to which elements may be added or removed.

pContext - the current update context.

Returns:

true if createMatchingTargetElement targets adds to pTargetCollection. Return false if the element should be added to pTargetCollection via add().

addNewTargetElement

protected void addNewTargetElement(java.util.Collection<java.lang.Object> pTargetCollection,
                                   java.lang.Object pTargetElement,
                                   ValidatorContext<?> pContext)

Add a new target element to the target collection. Default implementation just does an add

Parameters:

pTargetCollection - the collection to add an element to.

pTargetElement - the new element to add to the collection.

pIndex - the index at which to add.

pContext - the update context.

removeUnmatchedTargetValues

protected void removeUnmatchedTargetValues(java.util.Collection<java.lang.Object> pTargetCollection,
                                           java.util.List<java.lang.Object> pUnmatchedElements,
                                           ValidatorContext<?> pContext)

Remove the unmatched element (pUnmatchedElements) from pTargetCollection. Default just calls pTargetCollection.removeAll(pUnmatchedElements).

Parameters:

pTargetCollection - the collection from which elements should be removed.

pUnmatchedElements - the unmatched elements to be removed

pContext - the update context.

getMatchedPairs

protected java.util.List<atg.core.util.Pair.AliasedPair> getMatchedPairs(C collSrc,
                                                                         java.util.List<java.lang.Object> dstsUnmatched,
                                                                         ValidatorContext pContext)
                                                                  throws PropertyNotFoundException,
                                                                         java.beans.IntrospectionException,
                                                                         atg.core.exception.ItemNotFoundException

Throws:

PropertyNotFoundException

java.beans.IntrospectionException

atg.core.exception.ItemNotFoundException