org.kuali.rice.kns.datadictionary
Class DataDictionary

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionary

public class DataDictionary
extends Object

Collection of named BusinessObjectEntry objects, each of which contains information relating to the display, validation, and general maintenance of a BusinessObject.

Field Summary

static PersistenceStructureService

persistenceStructureService

Constructor Summary

DataDictionary()

Method Summary

void	addConfigFileLocation(String location)
static PropertyDescriptor	buildReadDescriptor(Class propertyClass, String propertyName)
static PropertyDescriptor	buildSimpleReadDescriptor(Class propertyClass, String propertyName)
Set<InactivationBlockingMetadata>	getAllInactivationBlockingMetadatas(Class blockedClass)
static Class	getAttributeClass(Class boClass, String attributeName) This method determines the Class of the attributeName passed in.
List<String>	getBusinessObjectClassNames()
Map<String,BusinessObjectEntry>	getBusinessObjectEntries()
BusinessObjectEntry	getBusinessObjectEntry(String className)
BusinessObjectEntry	getBusinessObjectEntryForConcreteClass(String className) This method gets the business object entry for a concrete class
static Class	getCollectionElementClass(Class boClass, String collectionName) This method determines the Class of the elements in the collectionName passed in.
List<String>	getConfigFileLocations()
DataDictionaryEntry	getDictionaryObjectEntry(String className)
Map<String,DocumentEntry>	getDocumentEntries()
DocumentEntry	getDocumentEntry(String documentTypeDDKey) Returns the KNS document entry for the given lookup key.
MaintenanceDocumentEntry	getMaintenanceDocumentEntryForBusinessObjectClass(Class businessObjectClass) Note: only MaintenanceDocuments are indexed by businessObject Class This is a special case that is referenced in one location.
static PersistenceStructureService	getPersistenceStructureService()
static boolean	isCollectionPropertyOf(Class targetClass, String propertyName)
static boolean	isPropertyOf(Class targetClass, String propertyName)
void	parseDataDictionaryConfigurationFiles(boolean allowConcurrentValidation)
void	performBeanOverrides() This method gathers beans of type BeanOverride and invokes each one's performOverride() method.
void	setConfigFileLocations(List<String> configFileLocations)
void	setDataDictionaryMapper(DataDictionaryMapper mapper) Sets the DataDictionaryMapper
void	validateDD()
void	validateDD(boolean validateEbos)

Methods inherited from class java.lang.Object

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

Field Detail

persistenceStructureService

public static PersistenceStructureService persistenceStructureService

Constructor Detail

DataDictionary

public DataDictionary()

Method Detail

getConfigFileLocations

public List<String> getConfigFileLocations()

setConfigFileLocations

public void setConfigFileLocations(List<String> configFileLocations)

addConfigFileLocation

public void addConfigFileLocation(String location)
                           throws IOException

Throws:

IOException

setDataDictionaryMapper

public void setDataDictionaryMapper(DataDictionaryMapper mapper)

Sets the DataDictionaryMapper

Parameters:

mapper - the datadictionary mapper

parseDataDictionaryConfigurationFiles

public void parseDataDictionaryConfigurationFiles(boolean allowConcurrentValidation)

validateDD

public void validateDD(boolean validateEbos)

validateDD

public void validateDD()

getBusinessObjectEntry

public BusinessObjectEntry getBusinessObjectEntry(String className)

Parameters:

className -

Returns:

BusinessObjectEntry for the named class, or null if none exists

getBusinessObjectEntryForConcreteClass

public BusinessObjectEntry getBusinessObjectEntryForConcreteClass(String className)

This method gets the business object entry for a concrete class

Parameters:

className -

Returns:

getBusinessObjectClassNames

public List<String> getBusinessObjectClassNames()

Returns:

List of businessObject classnames

getBusinessObjectEntries

public Map<String,BusinessObjectEntry> getBusinessObjectEntries()

Returns:

Map of (classname, BusinessObjectEntry) pairs

getDictionaryObjectEntry

public DataDictionaryEntry getDictionaryObjectEntry(String className)

Parameters:

className -

Returns:

DataDictionaryEntryBase for the named class, or null if none exists

getDocumentEntry

public DocumentEntry getDocumentEntry(String documentTypeDDKey)

Returns the KNS document entry for the given lookup key. The documentTypeDDKey is interpreted successively in the following ways until a mapping is found (or none if found):

1. KEW/workflow document type
2. business object class name
3. maintainable class name

This mapping is compiled when DataDictionary files are parsed on startup (or demand). Currently this means the mapping is static, and one-to-one (one KNS document maps directly to one and only one key).

Parameters:

documentTypeDDKey - the KEW/workflow document type name

Returns:

the KNS DocumentEntry if it exists

getMaintenanceDocumentEntryForBusinessObjectClass

public MaintenanceDocumentEntry getMaintenanceDocumentEntryForBusinessObjectClass(Class businessObjectClass)

Note: only MaintenanceDocuments are indexed by businessObject Class This is a special case that is referenced in one location. Do we need another map for this stuff??

Parameters:

businessObjectClass -

Returns:

DocumentEntry associated with the given Class, or null if there is none

getDocumentEntries

public Map<String,DocumentEntry> getDocumentEntries()

isPropertyOf

public static boolean isPropertyOf(Class targetClass,
                                   String propertyName)

Parameters:

clazz -

propertyName -

Returns:

true if the given propertyName names a property of the given class

Throws:

CompletionException - if there is a problem accessing the named property on the given class

isCollectionPropertyOf

public static boolean isCollectionPropertyOf(Class targetClass,
                                             String propertyName)

Parameters:

clazz -

propertyName -

Returns:

true if the given propertyName names a Collection property of the given class

Throws:

CompletionException - if there is a problem accessing the named property on the given class

getPersistenceStructureService

public static PersistenceStructureService getPersistenceStructureService()

Returns:

the persistenceStructureService

getAttributeClass

public static Class getAttributeClass(Class boClass,
                                      String attributeName)

This method determines the Class of the attributeName passed in. Null will be returned if the member is not available, or if a reflection exception is thrown.

Parameters:

rootClass - - Class that the attributeName property exists in.

attributeName - - Name of the attribute you want a class for.

Returns:

The Class of the attributeName, if the attribute exists on the rootClass. Null otherwise.

getCollectionElementClass

public static Class getCollectionElementClass(Class boClass,
                                              String collectionName)

This method determines the Class of the elements in the collectionName passed in.

Parameters:

boClass - Class that the collectionName collection exists in.

collectionName - the name of the collection you want the element class for

Returns:

buildReadDescriptor

public static PropertyDescriptor buildReadDescriptor(Class propertyClass,
                                                     String propertyName)

Parameters:

propertyClass -

propertyName -

Returns:

PropertyDescriptor for the getter for the named property of the given class, if one exists.

buildSimpleReadDescriptor

public static PropertyDescriptor buildSimpleReadDescriptor(Class propertyClass,
                                                           String propertyName)

Parameters:

propertyClass -

propertyName -

Returns:

PropertyDescriptor for the getter for the named property of the given class, if one exists.

getAllInactivationBlockingMetadatas

public Set<InactivationBlockingMetadata> getAllInactivationBlockingMetadatas(Class blockedClass)

performBeanOverrides

public void performBeanOverrides()

This method gathers beans of type BeanOverride and invokes each one's performOverride() method.