org.kuali.rice.krad.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) Deprecated.
Map<String,BusinessObjectEntry>	getBusinessObjectEntries(DataDictionaryIndex index) Deprecated.
BusinessObjectEntry	getBusinessObjectEntry(DataDictionaryIndex index, String className) Deprecated.
BusinessObjectEntry	getBusinessObjectEntryForConcreteClass(DataDictionaryIndex index, String className) Deprecated.
Map<String,DataObjectEntry>	getDataObjectEntries(DataDictionaryIndex index)
DataObjectEntry	getDataObjectEntry(DataDictionaryIndex index, String className)
DataObjectEntry	getDataObjectEntryForConcreteClass(DataDictionaryIndex index, String className) This method gets the DataOjectEntry (or subclass) 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.
View	getImmutableViewById(UifDictionaryIndex index, String viewId) Gets a view instance from the pool or factory but does not replace the view, meant for view readonly access (not running the lifecycle but just checking configuration)
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.
View	getViewById(UifDictionaryIndex index, String viewId) Returns the View entry identified by the given id
View	getViewByTypeIndex(UifDictionaryIndex index, UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Called to retrieve a View instance that is of the given type based on the index key
String	getViewIdByTypeIndex(UifDictionaryIndex index, UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Returns the view id for the view that matches the given view type and index
org.springframework.beans.PropertyValues	getViewPropertiesById(UifDictionaryIndex index, String viewId) Retrieves the configured property values for the view bean definition associated with the given id
org.springframework.beans.PropertyValues	getViewPropertiesByType(UifDictionaryIndex index, UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Retrieves the configured property values for the view bean definition associated with the given type and index
List<View>	getViewsForType(UifDictionaryIndex index, UifConstants.ViewType viewTypeName) Gets all View prototypes configured for the given view type name
boolean	viewByTypeExist(UifDictionaryIndex index, UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Indicates whether a View exists for the given view type and index information

Method Detail

getBusinessObjectEntryForConcreteClass

@Deprecated
BusinessObjectEntry getBusinessObjectEntryForConcreteClass(DataDictionaryIndex index,
                                                                      String className)

Deprecated.

This method gets the business object entry for a concrete class

Parameters:

className -

Returns:

business object entry

getDataObjectEntryForConcreteClass

DataObjectEntry getDataObjectEntryForConcreteClass(DataDictionaryIndex index,
                                                   String className)

This method gets the DataOjectEntry (or subclass) for a concrete class

Parameters:

className -

Returns:

the DataObjectEntry for the class or null if not found

getBusinessObjectClassNames

@Deprecated
List<String> getBusinessObjectClassNames(DataDictionaryIndex index)

Deprecated.

Returns:

List of businessObject classnames

getBusinessObjectEntry

@Deprecated
BusinessObjectEntry getBusinessObjectEntry(DataDictionaryIndex index,
                                                      String className)

Deprecated.

Parameters:

className -

Returns:

BusinessObjectEntry for the named class, or null if none exists

getDataObjectEntry

DataObjectEntry getDataObjectEntry(DataDictionaryIndex index,
                                   String className)

Parameters:

className -

Returns:

DataObjectEntry for the named class, or null if none exists

getBusinessObjectEntries

@Deprecated
Map<String,BusinessObjectEntry> getBusinessObjectEntries(DataDictionaryIndex index)

Deprecated.

Returns:

Map of (classname, BusinessObjectEntry) pairs

getDataObjectEntries

Map<String,DataObjectEntry> getDataObjectEntries(DataDictionaryIndex index)

Returns:

Map of (classname, DataObjectEntry) 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:

index - data dictionary index

documentTypeName - document type name to check for

Returns:

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

getViewById

View getViewById(UifDictionaryIndex index,
                 String viewId)

Returns the View entry identified by the given id

Parameters:

index - - the view dictionary index

viewId - - unique id for view

Returns:

View instance associated with the id

getImmutableViewById

View getImmutableViewById(UifDictionaryIndex index,
                          String viewId)

Gets a view instance from the pool or factory but does not replace the view, meant for view readonly access (not running the lifecycle but just checking configuration)

Parameters:

index - the view dictionary index

viewId - the unique id for the view

Returns:

View instance with the given id

getViewByTypeIndex

View getViewByTypeIndex(UifDictionaryIndex index,
                        UifConstants.ViewType viewTypeName,
                        Map<String,String> indexKey)

Called to retrieve a View instance that is of the given type based on the index key

Parameters:

index - - the view dictionary index

viewTypeName - - type name for the view

indexKey - - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

View instance that matches the given index

getViewIdByTypeIndex

String getViewIdByTypeIndex(UifDictionaryIndex index,
                            UifConstants.ViewType viewTypeName,
                            Map<String,String> indexKey)

Returns the view id for the view that matches the given view type and index

Parameters:

index - the view dictionary index

viewTypeName - type name for the view

indexKey - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

id for the view that matches the view type and index or null if a match is not found

viewByTypeExist

boolean viewByTypeExist(UifDictionaryIndex index,
                        UifConstants.ViewType viewTypeName,
                        Map<String,String> indexKey)

Indicates whether a View exists for the given view type and index information

Parameters:

index - - the view dictionary index

viewTypeName - - type name for the view

indexKey - - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

boolean true if view exists, false if not

getViewsForType

List<View> getViewsForType(UifDictionaryIndex index,
                           UifConstants.ViewType viewTypeName)

Gets all View prototypes configured for the given view type name

Parameters:

index - - the view dictionary index

viewTypeName - - view type name to retrieve

Returns:

List view prototypes with the given type name, or empty list

getViewPropertiesById

org.springframework.beans.PropertyValues getViewPropertiesById(UifDictionaryIndex index,
                                                               String viewId)

Retrieves the configured property values for the view bean definition associated with the given id

Since constructing the View object can be expensive, when metadata only is needed this method can be used to retrieve the configured property values. Note this looks at the merged bean definition

Parameters:

index - - the view dictionary index

viewId - - id for the view to retrieve

Returns:

PropertyValues configured on the view bean definition, or null if view is not found

getViewPropertiesByType

org.springframework.beans.PropertyValues getViewPropertiesByType(UifDictionaryIndex index,
                                                                 UifConstants.ViewType viewTypeName,
                                                                 Map<String,String> indexKey)

Retrieves the configured property values for the view bean definition associated with the given type and index

Since constructing the View object can be expensive, when metadata only is needed this method can be used to retrieve the configured property values. Note this looks at the merged bean definition

Parameters:

index - - the view dictionary index

viewTypeName - - type name for the view

indexKey - - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

PropertyValues configured on the view bean definition, or null if view is not found