org.kuali.rice.krad.service.impl

Class DictionaryValidationServiceImpl

java.lang.Object

org.kuali.rice.krad.service.impl.DictionaryValidationServiceImpl

All Implemented Interfaces:

DictionaryValidationService

public class DictionaryValidationServiceImpl
extends Object
implements DictionaryValidationService

Validates Documents, Business Objects, and Attributes against the data dictionary. Including min, max lengths, and validating expressions. This is the default, Kuali delivered implementation. KULRICE - 3355 Modified to prevent infinite looping (to maxDepth) scenario when a parent references a child which references a parent

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected DataDictionaryService	dataDictionaryService
protected DocumentDictionaryService	documentDictionaryService
static String	VALIDATE_METHOD Constant defines a validation method for an attribute value.

Constructor Summary

Constructors

Constructor and Description
DictionaryValidationServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<CollectionConstraintProcessor>	getCollectionConstraintProcessors() gets the list of CollectionConstraintProcessor
List<ConstraintProvider>	getConstraintProviders() gets the list of ConstraintProviders
DataDictionaryService	getDataDictionaryService() gets the DataDictionaryService
DocumentDictionaryService	getDocumentDictionaryService() gets the locally saved instance of @{link DocumentDictionaryService}
List<ConstraintProcessor>	getElementConstraintProcessors() gets the list of element ConstraintProcessor
LegacyDataAdapter	getLegacyDataAdapter() Deprecated.
boolean	isBusinessObjectValid(Object businessObject)
boolean	isBusinessObjectValid(Object businessObject, String prefix)
protected Set<Object>	newIdentitySet() creates a new IdentitySet.
protected void	processCollectionConstraints(DictionaryValidationResult result, Collection<?> collection, Constrainable definition, AttributeValueReader attributeValueReader, boolean doOptionalProcessing, String validationState, StateMapping stateMapping) process constraints for the provided collection using the collection constraint processors
protected void	processElementConstraints(DictionaryValidationResult result, Object value, Constrainable definition, AttributeValueReader attributeValueReader, boolean doOptionalProcessing, String validationState, StateMapping stateMapping) process constraints for the provided value using the element constraint processors
void	setCollectionConstraintProcessors(List<CollectionConstraintProcessor> collectionConstraintProcessors) sets the list of CollectionConstraintProcessor
void	setConstraintProviders(List<ConstraintProvider> constraintProviders) sets a list of ConstraintProvider
void	setDataDictionaryService(DataDictionaryService dataDictionaryService) sets the DataDictionaryService
void	setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService) sets the DocumentDictionaryService
void	setElementConstraintProcessors(List<ConstraintProcessor> elementConstraintProcessors) sets the list of ConstraintProcessor
DictionaryValidationResult	validate(AttributeValueReader valueReader, boolean doOptionalProcessing, String validationState, StateMapping stateMapping) Validates using the defined AttributeValueReader (which allows access the object being validated) against the validationState and stateMapping (if specified).
DictionaryValidationResult	validate(Object object)
DictionaryValidationResult	validate(Object object, String entryName, DataDictionaryEntry entry, boolean doOptionalProcessing)
DictionaryValidationResult	validate(Object object, String entryName, String attributeName, boolean doOptionalProcessing)
DictionaryValidationResult	validateAgainstNextState(Object object)
DictionaryValidationResult	validateAgainstState(Object object, String validationState)
protected void	validateAttribute(DictionaryValidationResult result, AttributeValueReader attributeValueReader, boolean checkIfRequired, String validationState, StateMapping stateMapping) validates an attribute
protected void	validateAttribute(DictionaryValidationResult result, Constrainable definition, AttributeValueReader attributeValueReader, boolean checkIfRequired, String validationState, StateMapping stateMapping) Validates the attribute specified by definition
void	validateBusinessObject(Object businessObject)
void	validateBusinessObject(Object businessObject, boolean validateRequired)
protected void	validateBusinessObjectsFromDescriptors(Object object, PropertyDescriptor[] propertyDescriptors, int depth) iterates through the property descriptors looking for business objects or lists of business objects.
void	validateBusinessObjectsRecursively(Object businessObject, int depth)
boolean	validateDefaultExistenceChecks(Object dataObject)
boolean	validateDefaultExistenceChecksForNewCollectionItem(Object dataObject, Object newCollectionItem, String collectionName)
boolean	validateDefaultExistenceChecksForNewCollectionItem(TransactionalDocument document, Object newCollectionItem, String collectionName)
boolean	validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)
void	validateDocument(Document document)
void	validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired)
void	validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName)
void	validateDocumentAttribute(Document document, String attributeName, String errorPrefix)
protected void	validateObject(DictionaryValidationResult result, AttributeValueReader attributeValueReader, boolean doOptionalProcessing, boolean processAttributes, String validationState, StateMapping stateMapping) validates an object and its attributes recursively
void	validatePrimitiveFromDescriptor(String entryName, Object object, PropertyDescriptor propertyDescriptor, String errorPrefix, boolean validateRequired) Deprecated. since 1.1
boolean	validateReferenceExists(Object dataObject, ReferenceDefinition reference)
boolean	validateReferenceExists(Object dataObject, String referenceName)
boolean	validateReferenceExistsAndIsActive(Object dataObject, ReferenceDefinition reference)
boolean	validateReferenceExistsAndIsActive(Object dataObject, String referenceName, String attributeToHighlightOnFail, String displayFieldName)
boolean	validateReferenceIsActive(Object dataObject, ReferenceDefinition reference)
boolean	validateReferenceIsActive(Object dataObject, String referenceName)
protected void	validateUpdatabableReferencesRecursively(Object businessObject, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName, Set<Object> processedBOs)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATE_METHOD

public static final String VALIDATE_METHOD

Constant defines a validation method for an attribute value.

Value is "validate"

See Also:

Constant Field Values

dataDictionaryService

protected DataDictionaryService dataDictionaryService

documentDictionaryService

protected DocumentDictionaryService documentDictionaryService

Constructor Detail

DictionaryValidationServiceImpl

public DictionaryValidationServiceImpl()

Method Detail

newIdentitySet

protected final Set<Object> newIdentitySet()

creates a new IdentitySet.

Returns:

a new Set

validate

public DictionaryValidationResult validate(Object object)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           String attributeName,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, java.lang.String, java.lang.String, boolean)

validateAgainstNextState

public DictionaryValidationResult validateAgainstNextState(Object object)

Specified by:

validateAgainstNextState in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateAgainstNextState(Object)

validateAgainstState

public DictionaryValidationResult validateAgainstState(Object object,
                                                       String validationState)

Specified by:

validateAgainstState in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateAgainstState(Object, String)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           DataDictionaryEntry entry,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(Object, String, DataDictionaryEntry, boolean)

validateDocument

public void validateDocument(Document document)

Specified by:

validateDocument in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocument(org.kuali.rice.krad.document.Document)

validateDocumentAttribute

public void validateDocumentAttribute(Document document,
                                      String attributeName,
                                      String errorPrefix)

Specified by:

validateDocumentAttribute in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAttribute(org.kuali.rice.krad.document.Document, java.lang.String, java.lang.String)

validateDocumentAndUpdatableReferencesRecursively

public void validateDocumentAndUpdatableReferencesRecursively(Document document,
                                                              int maxDepth,
                                                              boolean validateRequired)

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document, int, boolean)

validateDocumentAndUpdatableReferencesRecursively

public void validateDocumentAndUpdatableReferencesRecursively(Document document,
                                                              int maxDepth,
                                                              boolean validateRequired,
                                                              boolean chompLastLetterSFromCollectionName)

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document, int, boolean, boolean)

validateUpdatabableReferencesRecursively

protected void validateUpdatabableReferencesRecursively(Object businessObject,
                                                        int maxDepth,
                                                        boolean validateRequired,
                                                        boolean chompLastLetterSFromCollectionName,
                                                        Set<Object> processedBOs)

isBusinessObjectValid

public boolean isBusinessObjectValid(Object businessObject)

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

See Also:

org.kuali.rice.krad.service.DictionaryValidationService#isBusinessObjectValid(org.kuali.rice.krad.bo.BusinessObject)

isBusinessObjectValid

public boolean isBusinessObjectValid(Object businessObject,
                                     String prefix)

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

See Also:

org.kuali.rice.krad.service.DictionaryValidationService#isBusinessObjectValid(org.kuali.rice.krad.bo.BusinessObject, String)

validateBusinessObjectsRecursively

public void validateBusinessObjectsRecursively(Object businessObject,
                                               int depth)

Parameters:

businessObject - - business object to validate

validateBusinessObject

public void validateBusinessObject(Object businessObject)

Specified by:

validateBusinessObject in interface DictionaryValidationService

See Also:

org.kuali.rice.krad.service.DictionaryValidationService#validateBusinessObject(org.kuali.rice.krad.bo.BusinessObject)

validateBusinessObject

public void validateBusinessObject(Object businessObject,
                                   boolean validateRequired)

Specified by:

validateBusinessObject in interface DictionaryValidationService

See Also:

org.kuali.rice.krad.service.DictionaryValidationService#validateBusinessObject(org.kuali.rice.krad.bo.BusinessObject, boolean)

validateBusinessObjectsFromDescriptors

protected void validateBusinessObjectsFromDescriptors(Object object,
                                                      PropertyDescriptor[] propertyDescriptors,
                                                      int depth)

iterates through the property descriptors looking for business objects or lists of business objects. calls validate method for each bo found

Parameters:

object -

propertyDescriptors -

validatePrimitiveFromDescriptor

@Deprecated
public void validatePrimitiveFromDescriptor(String entryName,
                                                        Object object,
                                                        PropertyDescriptor propertyDescriptor,
                                                        String errorPrefix,
                                                        boolean validateRequired)

Deprecated. since 1.1

calls validate format and required check for the given propertyDescriptor

Specified by:

validatePrimitiveFromDescriptor in interface DictionaryValidationService

Parameters:

entryName -

object -

propertyDescriptor -

errorPrefix -

validateReferenceExists

public boolean validateReferenceExists(Object dataObject,
                                       ReferenceDefinition reference)

Specified by:

validateReferenceExists in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExists(java.lang.Object dataObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceExists

public boolean validateReferenceExists(Object dataObject,
                                       String referenceName)

Specified by:

validateReferenceExists in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExists(java.lang.Object dataObject, java.lang.String)

validateReferenceIsActive

public boolean validateReferenceIsActive(Object dataObject,
                                         ReferenceDefinition reference)

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceIsActive(java.lang.Object dataObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceIsActive

public boolean validateReferenceIsActive(Object dataObject,
                                         String referenceName)

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceIsActive(java.lang.Object dataObject, String)

validateReferenceExistsAndIsActive

public boolean validateReferenceExistsAndIsActive(Object dataObject,
                                                  ReferenceDefinition reference)

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExistsAndIsActive(java.lang.Object dataObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceExistsAndIsActive

public boolean validateReferenceExistsAndIsActive(Object dataObject,
                                                  String referenceName,
                                                  String attributeToHighlightOnFail,
                                                  String displayFieldName)

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExistsAndIsActive(java.lang.Object dataObject, String, String, String)

validateDefaultExistenceChecks

public boolean validateDefaultExistenceChecks(Object dataObject)

Specified by:

validateDefaultExistenceChecks in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecks(java.lang.Object dataObject)

validateDefaultExistenceChecksForNewCollectionItem

public boolean validateDefaultExistenceChecksForNewCollectionItem(Object dataObject,
                                                                  Object newCollectionItem,
                                                                  String collectionName)

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecksForNewCollectionItem(java.lang.Object dataObject, java.lang.Object newCollectionLine, java.lang.String collectionName)

validateDefaultExistenceChecksForTransDoc

public boolean validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)

Specified by:

validateDefaultExistenceChecksForTransDoc in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecksForTransDoc(org.kuali.rice.krad.document.TransactionalDocument)

validateDefaultExistenceChecksForNewCollectionItem

public boolean validateDefaultExistenceChecksForNewCollectionItem(TransactionalDocument document,
                                                                  Object newCollectionItem,
                                                                  String collectionName)

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

See Also:

org.kuali.rice.krad.service.DictionaryValidationService#validateDefaultExistenceChecksForNewCollectionItem(org.kuali.rice.krad.document.TransactionalDocument, org.kuali.rice.krad.bo.BusinessObject, String)

validate

public DictionaryValidationResult validate(AttributeValueReader valueReader,
                                           boolean doOptionalProcessing,
                                           String validationState,
                                           StateMapping stateMapping)

Validates using the defined AttributeValueReader (which allows access the object being validated) against the validationState and stateMapping (if specified).

If state information is null, validates the constraints as stateless (ie all constraints apply regardless of their states attribute).

Specified by:

validate in interface DictionaryValidationService

Parameters:

valueReader - - an object to validate

doOptionalProcessing - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

validationState -

stateMapping -

Returns:

processElementConstraints

protected void processElementConstraints(DictionaryValidationResult result,
                                         Object value,
                                         Constrainable definition,
                                         AttributeValueReader attributeValueReader,
                                         boolean doOptionalProcessing,
                                         String validationState,
                                         StateMapping stateMapping)

process constraints for the provided value using the element constraint processors

Parameters:

result - - used to store the validation results

value - - the object on which constraints are to be processed - the value of a complex attribute

definition - - a Data Dictionary definition e.g. ComplexAttributeDefinition

attributeValueReader - - a class that encapsulate access to both dictionary metadata and object field values

doOptionalProcessing - - true if the validation should do optional validation, false otherwise

processCollectionConstraints

protected void processCollectionConstraints(DictionaryValidationResult result,
                                            Collection<?> collection,
                                            Constrainable definition,
                                            AttributeValueReader attributeValueReader,
                                            boolean doOptionalProcessing,
                                            String validationState,
                                            StateMapping stateMapping)

process constraints for the provided collection using the collection constraint processors

Parameters:

result - - used to store the validation results

collection - - the object on which constraints are to be processed - a collection

definition - - a Data Dictionary definition e.g. CollectionDefinition

attributeValueReader - - a class that encapsulate access to both dictionary metadata and object field values

doOptionalProcessing - - true if the validation should do optional validation, false otherwise

validateAttribute

protected void validateAttribute(DictionaryValidationResult result,
                                 AttributeValueReader attributeValueReader,
                                 boolean checkIfRequired,
                                 String validationState,
                                 StateMapping stateMapping)
                          throws AttributeValidationException

validates an attribute

Parameters:

result - - used to store the validation results

attributeValueReader - - a class that encapsulate access to both dictionary metadata and object field values

checkIfRequired - - check if empty values are required or not

Throws:

AttributeValidationException

validateAttribute

protected void validateAttribute(DictionaryValidationResult result,
                                 Constrainable definition,
                                 AttributeValueReader attributeValueReader,
                                 boolean checkIfRequired,
                                 String validationState,
                                 StateMapping stateMapping)
                          throws AttributeValidationException

Validates the attribute specified by definition

Parameters:

definition - - the constrainable attribute definition of a specific attribute name

Throws:

AttributeValidationException

validateObject

protected void validateObject(DictionaryValidationResult result,
                              AttributeValueReader attributeValueReader,
                              boolean doOptionalProcessing,
                              boolean processAttributes,
                              String validationState,
                              StateMapping stateMapping)
                       throws AttributeValidationException

validates an object and its attributes recursively

Parameters:

result - - used to store the validation results

attributeValueReader - - a class that encapsulate access to both dictionary metadata and object field values

doOptionalProcessing - - true if the validation should do optional validation, false otherwise

processAttributes - - if true process all attribute definitions, skip if false

Throws:

AttributeValidationException

getDataDictionaryService

public DataDictionaryService getDataDictionaryService()

gets the DataDictionaryService

Returns:

Returns the dataDictionaryService

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

sets the DataDictionaryService

Parameters:

dataDictionaryService - The dataDictionaryService to set

getCollectionConstraintProcessors

public List<CollectionConstraintProcessor> getCollectionConstraintProcessors()

gets the list of CollectionConstraintProcessor

Collection constraint processors are classes that determine if a feature of a collection of objects satisfies some constraint

Returns:

the collectionConstraintProcessors

setCollectionConstraintProcessors

public void setCollectionConstraintProcessors(List<CollectionConstraintProcessor> collectionConstraintProcessors)

sets the list of CollectionConstraintProcessor

Parameters:

collectionConstraintProcessors - the collectionConstraintProcessors to set

getConstraintProviders

public List<ConstraintProvider> getConstraintProviders()

gets the list of ConstraintProviders

Constraint providers are classes that map specific constraint types to a constraint resolver, which takes a constrainable definition

Returns:

the constraintProviders

setConstraintProviders

public void setConstraintProviders(List<ConstraintProvider> constraintProviders)

sets a list of ConstraintProvider

Parameters:

constraintProviders - the constraintProviders to set

getElementConstraintProcessors

public List<ConstraintProcessor> getElementConstraintProcessors()

gets the list of element ConstraintProcessor

Element constraint processors are classes that determine if a passed value is valid for a specific constraint at the individual object or object attribute level

Returns:

the elementConstraintProcessors

setElementConstraintProcessors

public void setElementConstraintProcessors(List<ConstraintProcessor> elementConstraintProcessors)

sets the list of ConstraintProcessor

Parameters:

elementConstraintProcessors - the elementConstraintProcessors to set

getDocumentDictionaryService

public DocumentDictionaryService getDocumentDictionaryService()

gets the locally saved instance of @{link DocumentDictionaryService}

If the instance in this class has not be set, retrieve it using KRADServiceLocatorWeb.getDocumentDictionaryService() and save locally

Returns:

the locally saved instance of DocumentDictionaryService

setDocumentDictionaryService

public void setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)

sets the DocumentDictionaryService

Parameters:

documentDictionaryService - - the DocumentDictionaryService to set

getLegacyDataAdapter

@Deprecated
public LegacyDataAdapter getLegacyDataAdapter()

Deprecated.