org.kuali.rice.kns.datadictionary
Interface DataDictionaryMapper

All Known Implementing Classes:

DataDictionaryIndexMapper

public interface DataDictionaryMapper

Maps one Document type to other document Type. This interface can be used to implement KNS to workflow document type mapping relationships other than one-to-one.

Author:

mpk35

Method Summary

Set<InactivationBlockingMetadata>	getAllInactivationBlockingMetadatas(DataDictionaryIndex index, Class blockedClass)
List<String>	getBusinessObjectClassNames(DataDictionaryIndex index)
Map<String,BusinessObjectEntry>	getBusinessObjectEntries(DataDictionaryIndex index)
BusinessObjectEntry	getBusinessObjectEntry(DataDictionaryIndex index, String className)
BusinessObjectEntry	getBusinessObjectEntryForConcreteClass(DataDictionaryIndex index, String className) This method gets the business object entry for a concrete class
DataDictionaryEntry	getDictionaryObjectEntry(DataDictionaryIndex index, String className)
Map<String,DocumentEntry>	getDocumentEntries(DataDictionaryIndex index)
DocumentEntry	getDocumentEntry(DataDictionaryIndex index, String documentTypeDDKey) Returns the KNS document entry for the given lookup key.
String	getDocumentTypeName(DataDictionaryIndex index, String documentTypeName) Returns mapped document type based on the given document type.
MaintenanceDocumentEntry	getMaintenanceDocumentEntryForBusinessObjectClass(DataDictionaryIndex index, Class businessObjectClass) Note: only MaintenanceDocuments are indexed by businessObject Class This is a special case that is referenced in one location.

Method Detail

getBusinessObjectEntryForConcreteClass

BusinessObjectEntry getBusinessObjectEntryForConcreteClass(DataDictionaryIndex index,
                                                           String className)

This method gets the business object entry for a concrete class

Parameters:

className -

Returns:

getBusinessObjectClassNames

List<String> getBusinessObjectClassNames(DataDictionaryIndex index)

Returns:

List of businessObject classnames

getBusinessObjectEntry

BusinessObjectEntry getBusinessObjectEntry(DataDictionaryIndex index,
                                           String className)

Parameters:

className -

Returns:

BusinessObjectEntry for the named class, or null if none exists

getBusinessObjectEntries

Map<String,BusinessObjectEntry> getBusinessObjectEntries(DataDictionaryIndex index)

Returns:

Map of (classname, BusinessObjectEntry) pairs

getDictionaryObjectEntry

DataDictionaryEntry getDictionaryObjectEntry(DataDictionaryIndex index,
                                             String className)

Parameters:

className -

Returns:

DataDictionaryEntryBase for the named class, or null if none exists

getDocumentEntry

DocumentEntry getDocumentEntry(DataDictionaryIndex index,
                               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

MaintenanceDocumentEntry getMaintenanceDocumentEntryForBusinessObjectClass(DataDictionaryIndex index,
                                                                           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

Map<String,DocumentEntry> getDocumentEntries(DataDictionaryIndex index)

getAllInactivationBlockingMetadatas

Set<InactivationBlockingMetadata> getAllInactivationBlockingMetadatas(DataDictionaryIndex index,
                                                                      Class blockedClass)

getDocumentTypeName

String getDocumentTypeName(DataDictionaryIndex index,
                           String documentTypeName)

Returns mapped document type based on the given document type.

Parameters:

documentType -

Returns:

new document type or null if given documentType was not found.