org.kuali.rice.krad.datadictionary.validation.processor

Class CollectionSizeConstraintProcessor

java.lang.Object

org.kuali.rice.krad.datadictionary.validation.processor.CollectionSizeConstraintProcessor

All Implemented Interfaces:

CollectionConstraintProcessor<Collection<?>,CollectionSizeConstraint>, ConstraintProcessor<Collection<?>,CollectionSizeConstraint>

public class CollectionSizeConstraintProcessor
extends Object
implements CollectionConstraintProcessor<Collection<?>,CollectionSizeConstraint>

This class validates attributes that are collection size constrained - ones that can only have between x and y number

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
CollectionSizeConstraintProcessor()

Method Summary

Modifier and Type	Method and Description
Class<? extends Constraint>	getConstraintType() gets the java class type of the constraint that this contraint processor handles
String	getName() gets a descriptive name of this constraint processor
boolean	isOptional() returns true if the processing of this constraint is something that can be opted out of by some pieces of code.
ProcessorResult	process(DictionaryValidationResult result, Collection<?> collection, CollectionSizeConstraint constraint, AttributeValueReader attributeValueReader) process the provided constraint
protected ConstraintValidationResult	processSingleCollectionSizeConstraint(DictionaryValidationResult result, Collection<?> collection, CollectionSizeConstraint constraint, AttributeValueReader attributeValueReader)

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionSizeConstraintProcessor

public CollectionSizeConstraintProcessor()

Method Detail

process

public ProcessorResult process(DictionaryValidationResult result,
                               Collection<?> collection,
                               CollectionSizeConstraint constraint,
                               AttributeValueReader attributeValueReader)
                        throws AttributeValidationException

Description copied from interface: ConstraintProcessor

process the provided constraint

Specified by:

process in interface ConstraintProcessor<Collection<?>,CollectionSizeConstraint>

Parameters:

result - - holds dictionary validation results

collection - - the value of the attribute

constraint - - the constraint to process

attributeValueReader - - - provides access to the attribute being validated

Returns:

the result of the constraint processing

Throws:

AttributeValidationException

See Also:

ConstraintProcessor.process(org.kuali.rice.krad.datadictionary.validation.result.DictionaryValidationResult, Object, org.kuali.rice.krad.datadictionary.validation.constraint.Constraint, org.kuali.rice.krad.datadictionary.validation.AttributeValueReader)

getName

public String getName()

Description copied from interface: ConstraintProcessor

gets a descriptive name of this constraint processor

e.g. @see CollectionSizeConstraintProcessor.CONSTRAINT_NAME

Specified by:

getName in interface ConstraintProcessor<Collection<?>,CollectionSizeConstraint>

Returns:

a descriptive name

getConstraintType

public Class<? extends Constraint> getConstraintType()

Description copied from interface: ConstraintProcessor

gets the java class type of the constraint that this contraint processor handles

Specified by:

getConstraintType in interface ConstraintProcessor<Collection<?>,CollectionSizeConstraint>

Returns:

an instance of Constraint

See Also:

ConstraintProcessor.getConstraintType()

isOptional

public boolean isOptional()

Description copied from interface: ConstraintProcessor

returns true if the processing of this constraint is something that can be opted out of by some pieces of code. The only example of this in the version under development (1.1) is the existence constraint.

Specified by:

isOptional in interface ConstraintProcessor<Collection<?>,CollectionSizeConstraint>

Returns:

true if this processor can be turned off by some pieces of code, false otherwise

See Also:

ConstraintProcessor.isOptional()

processSingleCollectionSizeConstraint

protected ConstraintValidationResult processSingleCollectionSizeConstraint(DictionaryValidationResult result,
                                                                           Collection<?> collection,
                                                                           CollectionSizeConstraint constraint,
                                                                           AttributeValueReader attributeValueReader)
                                                                    throws AttributeValidationException

Throws:

AttributeValidationException