org.kuali.rice.kns.kim.type

Class DataDictionaryTypeServiceBase

java.lang.Object

org.kuali.rice.kns.kim.type.DataDictionaryTypeServiceBase

All Implemented Interfaces:

org.kuali.rice.kim.framework.type.KimTypeService

Direct Known Subclasses:

GroupTypeServiceBase, KimResponsibilityTypeServiceBase, PermissionTypeServiceBase, RoleTypeServiceBase

public class DataDictionaryTypeServiceBase
extends Object
implements org.kuali.rice.kim.framework.type.KimTypeService

A base class for KimTypeService implementations which read attribute-related information from the Data Dictionary. This implementation is currently written against the KNS apis for Data Dictionary. Additionally, it supports the ability to read non-Data Dictionary attribute information from the KimTypeInfoService.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataDictionaryTypeServiceBase.KimTypeAttributeException
protected static class	DataDictionaryTypeServiceBase.KimTypeAttributeValidationException

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMA_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DataDictionaryTypeServiceBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	areAttributesEqual(List<String> uniqueAttributeNames, Map<String,String> aSet1, Map<String,String> aSet2)
protected List<String>	extractErrorsFromGlobalVariablesErrorMap(String attributeName)
List<KimAttributeField>	getAttributeDefinitions(String kimTypeId)
protected Formatter	getAttributeFormatter(KimAttributeField definition)
protected Double	getAttributeMaxValue(KimAttributeField definition)
protected Double	getAttributeMinValue(KimAttributeField definition)
protected Pattern	getAttributeValidatingExpression(KimAttributeField definition)
protected String	getAttributeValue(Map<String,String> aSet, String attributeName)
protected BusinessObjectService	getBusinessObjectService()
protected String	getClosestParentDocumentTypeName(org.kuali.rice.kew.api.doctype.DocumentType documentType, Set<String> potentialParentDocumentTypeNames)
protected KimAttributeField	getDataDictionaryAttributeDefinition(String namespaceCode, String kimTypeId, KimTypeAttribute typeAttribute, List<String> uniqueAttributes)
protected DataDictionaryService	getDataDictionaryService()
protected DictionaryValidationService	getDictionaryValidationService()
protected org.kuali.rice.kew.api.doctype.DocumentTypeService	getDocumentTypeService()
protected KimAttributeField	getNonDataDictionaryAttributeDefinition(String namespaceCode, String kimTypeId, KimTypeAttribute typeAttribute, List<String> uniqueAttributes)
protected List<String>	getRequiredAttributes()
protected KimTypeInfoService	getTypeInfoService()
protected List<String>	getUniqueAttributes(String kimTypeId)
String	getWorkflowDocumentTypeName()
List<String>	getWorkflowRoutingAttributes(String routeLevel)
protected boolean	isCheckRequiredAttributes()
protected boolean	performMatch(Map<String,String> inputAttributes, Map<String,String> storedAttributes) This method matches input attribute set entries and standard attribute set entries using literal string match.
protected Map<String,String>	translateInputAttributes(Map<String,String> qualification)
protected List<RemotableAttributeError>	validateAttributeFormat(String kimTypeId, String objectClassName, String attributeName, String attributeValue, String errorKey)
protected List<RemotableAttributeError>	validateAttributeRequired(String kimTypeId, String objectClassName, String attributeName, Object attributeValue, String errorKey)
List<RemotableAttributeError>	validateAttributes(String kimTypeId, Map<String,String> attributes) This is the default implementation.
List<RemotableAttributeError>	validateAttributesAgainstExisting(String kimTypeId, Map<String,String> newAttributes, Map<String,String> oldAttributes)
protected List<RemotableAttributeError>	validateDataDictionaryAttribute(KimTypeAttribute attr, String key, String value)
protected List<RemotableAttributeError>	validateDataDictionaryAttribute(String kimTypeId, String entryName, Object object, PropertyDescriptor propertyDescriptor)
protected List<RemotableAttributeError>	validateNonDataDictionaryAttribute(KimTypeAttribute attr, String key, String value)
protected List<RemotableAttributeError>	validatePrimitiveFromDescriptor(String kimTypeId, String entryName, Object object, PropertyDescriptor propertyDescriptor)
protected List<RemotableAttributeError>	validateReferencesExistAndActive(KimType kimType, Map<String,String> attributes, List<RemotableAttributeError> previousValidationErrors)
protected void	validateRequiredAttributesAgainstReceived(Map<String,String> receivedAttributes)
List<RemotableAttributeError>	validateUniqueAttributes(String kimTypeId, Map<String,String> newAttributes, Map<String,String> oldAttributes)
List<RemotableAttributeError>	validateUnmodifiableAttributes(String kimTypeId, Map<String,String> originalAttributes, Map<String,String> newAttributes)

Methods inherited from class java.lang.Object

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

Field Detail

COMMA_SEPARATOR

protected static final String COMMA_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DataDictionaryTypeServiceBase

public DataDictionaryTypeServiceBase()

Method Detail

getWorkflowDocumentTypeName

public String getWorkflowDocumentTypeName()

Specified by:

getWorkflowDocumentTypeName in interface org.kuali.rice.kim.framework.type.KimTypeService

getWorkflowRoutingAttributes

public List<String> getWorkflowRoutingAttributes(String routeLevel)

Specified by:

getWorkflowRoutingAttributes in interface org.kuali.rice.kim.framework.type.KimTypeService

getAttributeDefinitions

public List<KimAttributeField> getAttributeDefinitions(String kimTypeId)

Specified by:

getAttributeDefinitions in interface org.kuali.rice.kim.framework.type.KimTypeService

validateAttributes

public List<RemotableAttributeError> validateAttributes(String kimTypeId,
                                                        Map<String,String> attributes)

This is the default implementation. It calls into the service for each attribute to validate it there. No combination validation is done. That should be done by overriding this method.

Specified by:

validateAttributes in interface org.kuali.rice.kim.framework.type.KimTypeService

validateAttributesAgainstExisting

public List<RemotableAttributeError> validateAttributesAgainstExisting(String kimTypeId,
                                                                       Map<String,String> newAttributes,
                                                                       Map<String,String> oldAttributes)

Specified by:

validateAttributesAgainstExisting in interface org.kuali.rice.kim.framework.type.KimTypeService

performMatch

protected boolean performMatch(Map<String,String> inputAttributes,
                               Map<String,String> storedAttributes)

This method matches input attribute set entries and standard attribute set entries using literal string match.

translateInputAttributes

protected Map<String,String> translateInputAttributes(Map<String,String> qualification)

validateReferencesExistAndActive

protected List<RemotableAttributeError> validateReferencesExistAndActive(KimType kimType,
                                                                         Map<String,String> attributes,
                                                                         List<RemotableAttributeError> previousValidationErrors)

validateAttributeRequired

protected List<RemotableAttributeError> validateAttributeRequired(String kimTypeId,
                                                                  String objectClassName,
                                                                  String attributeName,
                                                                  Object attributeValue,
                                                                  String errorKey)

validateDataDictionaryAttribute

protected List<RemotableAttributeError> validateDataDictionaryAttribute(String kimTypeId,
                                                                        String entryName,
                                                                        Object object,
                                                                        PropertyDescriptor propertyDescriptor)

validatePrimitiveFromDescriptor

protected List<RemotableAttributeError> validatePrimitiveFromDescriptor(String kimTypeId,
                                                                        String entryName,
                                                                        Object object,
                                                                        PropertyDescriptor propertyDescriptor)

getAttributeValidatingExpression

protected Pattern getAttributeValidatingExpression(KimAttributeField definition)

getAttributeFormatter

protected Formatter getAttributeFormatter(KimAttributeField definition)

getAttributeMinValue

protected Double getAttributeMinValue(KimAttributeField definition)

getAttributeMaxValue

protected Double getAttributeMaxValue(KimAttributeField definition)

validateAttributeFormat

protected List<RemotableAttributeError> validateAttributeFormat(String kimTypeId,
                                                                String objectClassName,
                                                                String attributeName,
                                                                String attributeValue,
                                                                String errorKey)

extractErrorsFromGlobalVariablesErrorMap

protected List<String> extractErrorsFromGlobalVariablesErrorMap(String attributeName)

validateNonDataDictionaryAttribute

protected List<RemotableAttributeError> validateNonDataDictionaryAttribute(KimTypeAttribute attr,
                                                                           String key,
                                                                           String value)

validateDataDictionaryAttribute

protected List<RemotableAttributeError> validateDataDictionaryAttribute(KimTypeAttribute attr,
                                                                        String key,
                                                                        String value)

getDataDictionaryAttributeDefinition

protected KimAttributeField getDataDictionaryAttributeDefinition(String namespaceCode,
                                                                 String kimTypeId,
                                                                 KimTypeAttribute typeAttribute,
                                                                 List<String> uniqueAttributes)

Parameters:

namespaceCode -

typeAttribute -

Returns:

an AttributeDefinition for the given KimTypeAttribute, or null no base AttributeDefinition matches the typeAttribute parameter's attributeName.

getNonDataDictionaryAttributeDefinition

protected KimAttributeField getNonDataDictionaryAttributeDefinition(String namespaceCode,
                                                                    String kimTypeId,
                                                                    KimTypeAttribute typeAttribute,
                                                                    List<String> uniqueAttributes)

validateRequiredAttributesAgainstReceived

protected void validateRequiredAttributesAgainstReceived(Map<String,String> receivedAttributes)

validateUniqueAttributes

public List<RemotableAttributeError> validateUniqueAttributes(String kimTypeId,
                                                              Map<String,String> newAttributes,
                                                              Map<String,String> oldAttributes)

Specified by:

validateUniqueAttributes in interface org.kuali.rice.kim.framework.type.KimTypeService

areAttributesEqual

protected boolean areAttributesEqual(List<String> uniqueAttributeNames,
                                     Map<String,String> aSet1,
                                     Map<String,String> aSet2)

getAttributeValue

protected String getAttributeValue(Map<String,String> aSet,
                                   String attributeName)

getUniqueAttributes

protected List<String> getUniqueAttributes(String kimTypeId)

validateUnmodifiableAttributes

public List<RemotableAttributeError> validateUnmodifiableAttributes(String kimTypeId,
                                                                    Map<String,String> originalAttributes,
                                                                    Map<String,String> newAttributes)

Specified by:

validateUnmodifiableAttributes in interface org.kuali.rice.kim.framework.type.KimTypeService

getRequiredAttributes

protected List<String> getRequiredAttributes()

isCheckRequiredAttributes

protected boolean isCheckRequiredAttributes()

getClosestParentDocumentTypeName

protected String getClosestParentDocumentTypeName(org.kuali.rice.kew.api.doctype.DocumentType documentType,
                                                  Set<String> potentialParentDocumentTypeNames)

getTypeInfoService

protected KimTypeInfoService getTypeInfoService()

getBusinessObjectService

protected BusinessObjectService getBusinessObjectService()

getDictionaryValidationService

protected DictionaryValidationService getDictionaryValidationService()

getDataDictionaryService

protected DataDictionaryService getDataDictionaryService()

getDocumentTypeService

protected org.kuali.rice.kew.api.doctype.DocumentTypeService getDocumentTypeService()