Package org.kuali.rice.krad.service.impl
Class DataDictionaryServiceImpl
java.lang.Object
org.kuali.rice.krad.service.impl.DataDictionaryServiceImpl
- All Implemented Interfaces:
DataDictionaryService
Service implementation for a DataDictionary. It is a thin wrapper around creating, initializing, and
returning a DataDictionary. This is the default, Kuali delivered implementation
- Author:
- Kuali Rice Team (rice.collab@kuali.org)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDataDictionaryLocations(String namespaceCode, List<String> locations) booleangetAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass) Returns all of the inactivation blocks registered for a particular business objectgetAttributeControlDefinition(Class dataObjectClass, String attributeName) getAttributeControlDefinition(String entryName, String attributeName) getAttributeDefinition(String entryName, String attributeName) getAttributeDescription(Class dataObjectClass, String attributeName) getAttributeDescription(String entryName, String attributeName) getAttributeErrorLabel(Class dataObjectClass, String attributeName) getAttributeErrorLabel(String entryName, String attributeName) getAttributeExclusiveMin(String entryName, String attributeName) getAttributeForceUppercase(Class dataObjectClass, String attributeName) getAttributeForceUppercase(String entryName, String attributeName) Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(Class dataObjectClass, String attributeName) Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(String entryName, String attributeName) getAttributeInclusiveMax(String entryName, String attributeName) getAttributeLabel(Class dataObjectClass, String attributeName) getAttributeLabel(String entryName, String attributeName) getAttributeMaxLength(Class dataObjectClass, String attributeName) getAttributeMaxLength(String entryName, String attributeName) getAttributeMinLength(String entryName, String attributeName) getAttributeSecurity(String entryName, String attributeName) getAttributeShortLabel(Class dataObjectClass, String attributeName) getAttributeShortLabel(String entryName, String attributeName) getAttributeSize(Class dataObjectClass, String attributeName) getAttributeSize(String entryName, String attributeName) getAttributeSummary(Class dataObjectClass, String attributeName) getAttributeSummary(String entryName, String attributeName) getAttributeValidatingErrorMessageKey(String entryName, String attributeName) String[]getAttributeValidatingErrorMessageParameters(String entryName, String attributeName) getAttributeValidatingExpression(Class dataObjectClass, String attributeName) getAttributeValidatingExpression(String entryName, String attributeName) getAttributeValuesFinderClass(Class dataObjectClass, String attributeName) Class<? extends KeyValuesFinder> getAttributeValuesFinderClass(String entryName, String attributeName) getCollectionDescription(Class dataObjectClass, String collectionName) getCollectionDescription(String entryName, String collectionName) getCollectionElementLabel(String entryName, String collectionName, Class dataObjectClass) getCollectionLabel(Class dataObjectClass, String collectionName) getCollectionLabel(String entryName, String collectionName) getCollectionShortLabel(Class dataObjectClass, String collectionName) getCollectionShortLabel(String entryName, String collectionName) getCollectionSummary(Class dataObjectClass, String collectionName) getCollectionSummary(String entryName, String collectionName) getDictionaryBeanProperty(String beanName, String propertyName) getDocumentClassByTypeName(String documentTypeName) getDocumentLabelByClass(Class documentOrBusinessObjectClass) getDocumentLabelByTypeName(String documentTypeName) getDocumentTypeNameByClass(Class documentClass) org.kuali.rice.kew.api.doctype.DocumentTypeServicegetGroupByAttributesForEffectiveDating(Class dataObjectClass) org.kuali.rice.core.api.config.property.ConfigurationServicegetRelationshipAttributeMap(String entryName, String relationshipName) getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName) getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName) getRelationshipNames(String entryName) getRelationshipSourceAttributes(String entryName, String relationshipName) Class<? extends BusinessObject> getRelationshipSourceClass(String entryName, String relationshipName) getRelationshipTargetAttributes(String entryName, String relationshipName) Class<? extends BusinessObject> getRelationshipTargetClass(String entryName, String relationshipName) getValidDocumentClassByTypeName(String documentTypeName) getValidDocumentTypeNameByClass(Class documentClass) getViewById(String viewId) getViewByTypeIndex(UifConstants.ViewType viewTypeName, Map<String, String> indexKey) getViewIdByTypeIndex(UifConstants.ViewType viewTypeName, Map<String, String> indexKey) booleanhasRelationship(String entryName, String relationshipName) isAttributeDefined(Class dataObjectClass, String attributeName) isAttributeDefined(String entryName, String attributeName) isAttributeRequired(Class dataObjectClass, String attributeName) isAttributeRequired(String entryName, String attributeName) voidsetAdditionalDictionaryFiles(Map<String, List<String>> additionalDictionaryFiles) voidsetDataDictionary(DataDictionary dataDictionary) voidsetKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService) voidsetKualiModuleService(KualiModuleService kualiModuleService) voidsetPropertyEditorMap(Map<Class<?>, String> propertyEditorMap)
-
Constructor Details
-
DataDictionaryServiceImpl
public DataDictionaryServiceImpl() -
DataDictionaryServiceImpl
-
-
Method Details
-
setAdditionalDictionaryFiles
public void setAdditionalDictionaryFiles(Map<String, List<String>> additionalDictionaryFiles) throws IOException- Specified by:
setAdditionalDictionaryFilesin interfaceDataDictionaryService- Throws:
IOException
-
addDataDictionaryLocations
public void addDataDictionaryLocations(String namespaceCode, List<String> locations) throws IOException - Specified by:
addDataDictionaryLocationsin interfaceDataDictionaryService- Throws:
IOException
-
getDataDictionary
- Specified by:
getDataDictionaryin interfaceDataDictionaryService
-
setDataDictionary
- Specified by:
setDataDictionaryin interfaceDataDictionaryService
-
getAttributeControlDefinition
- Specified by:
getAttributeControlDefinitionin interfaceDataDictionaryService
-
getAttributeSize
- Specified by:
getAttributeSizein interfaceDataDictionaryService
-
getAttributeMinLength
- Specified by:
getAttributeMinLengthin interfaceDataDictionaryService
-
getAttributeMaxLength
- Specified by:
getAttributeMaxLengthin interfaceDataDictionaryService
-
getAttributeExclusiveMin
- Specified by:
getAttributeExclusiveMinin interfaceDataDictionaryService
-
getAttributeInclusiveMax
- Specified by:
getAttributeInclusiveMaxin interfaceDataDictionaryService
-
getAttributeValidatingExpression
- Specified by:
getAttributeValidatingExpressionin interfaceDataDictionaryService
-
getAttributeLabel
- Specified by:
getAttributeLabelin interfaceDataDictionaryService
-
getAttributeShortLabel
- Specified by:
getAttributeShortLabelin interfaceDataDictionaryService
-
getAttributeErrorLabel
- Specified by:
getAttributeErrorLabelin interfaceDataDictionaryService
-
getAttributeFormatter
public Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(String entryName, String attributeName) - Specified by:
getAttributeFormatterin interfaceDataDictionaryService
-
getAttributeForceUppercase
public Boolean getAttributeForceUppercase(String entryName, String attributeName) throws UnknownBusinessClassAttributeException - Specified by:
getAttributeForceUppercasein interfaceDataDictionaryService- Throws:
UnknownBusinessClassAttributeException
-
getAttributeSecurity
- Specified by:
getAttributeSecurityin interfaceDataDictionaryService
-
getAttributeSummary
- Specified by:
getAttributeSummaryin interfaceDataDictionaryService
-
getAttributeDescription
- Specified by:
getAttributeDescriptionin interfaceDataDictionaryService- See Also:
-
isAttributeRequired
- Specified by:
isAttributeRequiredin interfaceDataDictionaryService- See Also:
-
isAttributeDefined
- Specified by:
isAttributeDefinedin interfaceDataDictionaryService- See Also:
-
getAttributeValuesFinderClass
public Class<? extends KeyValuesFinder> getAttributeValuesFinderClass(String entryName, String attributeName) - Specified by:
getAttributeValuesFinderClassin interfaceDataDictionaryService- See Also:
-
getCollectionLabel
- Specified by:
getCollectionLabelin interfaceDataDictionaryService- See Also:
-
getCollectionShortLabel
- Specified by:
getCollectionShortLabelin interfaceDataDictionaryService- See Also:
-
getCollectionElementLabel
public String getCollectionElementLabel(String entryName, String collectionName, Class dataObjectClass) - Specified by:
getCollectionElementLabelin interfaceDataDictionaryService- See Also:
-
getCollectionSummary
- Specified by:
getCollectionSummaryin interfaceDataDictionaryService- See Also:
-
getCollectionDescription
- Specified by:
getCollectionDescriptionin interfaceDataDictionaryService- See Also:
-
getRelationshipSourceClass
public Class<? extends BusinessObject> getRelationshipSourceClass(String entryName, String relationshipName) - Specified by:
getRelationshipSourceClassin interfaceDataDictionaryService
-
getRelationshipTargetClass
public Class<? extends BusinessObject> getRelationshipTargetClass(String entryName, String relationshipName) - Specified by:
getRelationshipTargetClassin interfaceDataDictionaryService
-
getRelationshipSourceAttributes
- Specified by:
getRelationshipSourceAttributesin interfaceDataDictionaryService
-
getRelationshipTargetAttributes
- Specified by:
getRelationshipTargetAttributesin interfaceDataDictionaryService
-
getRelationshipEntriesForSourceAttribute
public List<String> getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName) - Specified by:
getRelationshipEntriesForSourceAttributein interfaceDataDictionaryService
-
getRelationshipEntriesForTargetAttribute
public List<String> getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName) - Specified by:
getRelationshipEntriesForTargetAttributein interfaceDataDictionaryService
-
getAttributeDefinition
- Specified by:
getAttributeDefinitionin interfaceDataDictionaryService- Parameters:
entryName- - the qualified object name e.g. edu.sampleu.demo.kitchensink.TimeInfoattributeName- - an attribute name e.g. startTimeAmPm- Returns:
- AttributeDefinition for the given dataObjectClass and attribute name, or null if there is none
- Throws:
IllegalArgumentException- if the given Class is null or is not a BusinessObject class
-
getRelationshipAttributeMap
- Specified by:
getRelationshipAttributeMapin interfaceDataDictionaryService- See Also:
-
hasRelationship
- Specified by:
hasRelationshipin interfaceDataDictionaryService
-
getRelationshipNames
- Specified by:
getRelationshipNamesin interfaceDataDictionaryService
-
getAttributeControlDefinition
- Specified by:
getAttributeControlDefinitionin interfaceDataDictionaryService- See Also:
-
getAttributeDescription
- Specified by:
getAttributeDescriptionin interfaceDataDictionaryService- See Also:
-
getAttributeForceUppercase
- Specified by:
getAttributeForceUppercasein interfaceDataDictionaryService- See Also:
-
getAttributeFormatter
public Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(Class dataObjectClass, String attributeName) - Specified by:
getAttributeFormatterin interfaceDataDictionaryService- See Also:
-
getAttributeLabel
- Specified by:
getAttributeLabelin interfaceDataDictionaryService- See Also:
-
getAttributeMaxLength
- Specified by:
getAttributeMaxLengthin interfaceDataDictionaryService- See Also:
-
getAttributeShortLabel
- Specified by:
getAttributeShortLabelin interfaceDataDictionaryService- See Also:
-
getAttributeErrorLabel
- Specified by:
getAttributeErrorLabelin interfaceDataDictionaryService- See Also:
-
getAttributeSize
- Specified by:
getAttributeSizein interfaceDataDictionaryService- See Also:
-
getAttributeSummary
- Specified by:
getAttributeSummaryin interfaceDataDictionaryService- See Also:
-
getAttributeValidatingExpression
- Specified by:
getAttributeValidatingExpressionin interfaceDataDictionaryService- See Also:
-
getAttributeValuesFinderClass
- Specified by:
getAttributeValuesFinderClassin interfaceDataDictionaryService- See Also:
-
getAttributeValidatingErrorMessageKey
- Specified by:
getAttributeValidatingErrorMessageKeyin interfaceDataDictionaryService- See Also:
-
getAttributeValidatingErrorMessageParameters
public String[] getAttributeValidatingErrorMessageParameters(String entryName, String attributeName) - Specified by:
getAttributeValidatingErrorMessageParametersin interfaceDataDictionaryService- See Also:
-
getCollectionDescription
- Specified by:
getCollectionDescriptionin interfaceDataDictionaryService- See Also:
-
getCollectionLabel
- Specified by:
getCollectionLabelin interfaceDataDictionaryService- See Also:
-
getCollectionShortLabel
- Specified by:
getCollectionShortLabelin interfaceDataDictionaryService- See Also:
-
getCollectionSummary
- Specified by:
getCollectionSummaryin interfaceDataDictionaryService- See Also:
-
isAttributeDefined
- Specified by:
isAttributeDefinedin interfaceDataDictionaryService- See Also:
-
isAttributeRequired
- Specified by:
isAttributeRequiredin interfaceDataDictionaryService- See Also:
-
getDocumentLabelByClass
- Specified by:
getDocumentLabelByClassin interfaceDataDictionaryService- See Also:
-
getDocumentLabelByTypeName
- Specified by:
getDocumentLabelByTypeNamein interfaceDataDictionaryService- See Also:
-
getDocumentTypeNameByClass
- Specified by:
getDocumentTypeNameByClassin interfaceDataDictionaryService- See Also:
-
getValidDocumentTypeNameByClass
- Specified by:
getValidDocumentTypeNameByClassin interfaceDataDictionaryService- See Also:
-
getDocumentClassByTypeName
- Specified by:
getDocumentClassByTypeNamein interfaceDataDictionaryService- See Also:
-
getValidDocumentClassByTypeName
- Specified by:
getValidDocumentClassByTypeNamein interfaceDataDictionaryService- See Also:
-
getViewById
- Specified by:
getViewByIdin interfaceDataDictionaryService- See Also:
-
getDictionaryBean
- Specified by:
getDictionaryBeanin interfaceDataDictionaryService- See Also:
-
containsDictionaryBean
- Specified by:
containsDictionaryBeanin interfaceDataDictionaryService- See Also:
-
getDictionaryBeanProperty
- Specified by:
getDictionaryBeanPropertyin interfaceDataDictionaryService
-
getViewByTypeIndex
- Specified by:
getViewByTypeIndexin interfaceDataDictionaryService- See Also:
-
getViewIdByTypeIndex
- Specified by:
getViewIdByTypeIndexin interfaceDataDictionaryService- See Also:
-
getGroupByAttributesForEffectiveDating
- Specified by:
getGroupByAttributesForEffectiveDatingin interfaceDataDictionaryService- See Also:
-
getAllInactivationBlockingDefinitions
public Set<InactivationBlockingMetadata> getAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass) Returns all of the inactivation blocks registered for a particular business object- Specified by:
getAllInactivationBlockingDefinitionsin interfaceDataDictionaryService- See Also:
-
getPropertyEditorMap
- Specified by:
getPropertyEditorMapin interfaceDataDictionaryService
-
setPropertyEditorMap
- Parameters:
propertyEditorMap- mapping from property type to property editor- See Also:
-
getDocumentTypeService
public org.kuali.rice.kew.api.doctype.DocumentTypeService getDocumentTypeService() -
setKualiConfigurationService
public void setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService) -
getKualiConfigurationService
public org.kuali.rice.core.api.config.property.ConfigurationService getKualiConfigurationService() -
getKualiModuleService
-
setKualiModuleService
-