org.kuali.student.r1.common.assembly.dictionary

Class MetadataServiceImpl

java.lang.Object

org.kuali.student.r1.common.assembly.dictionary.MetadataServiceImpl

Direct Known Subclasses:

ProgramMetadataServiceImpl

public class MetadataServiceImpl
extends Object

This class provides metadata lookup for service dto objects.

Author:

Kuali Student Team

Constructor Summary

Constructors

Constructor and Description
MetadataServiceImpl()
MetadataServiceImpl(DictionaryService... dictionaryServices) Create a metadata service initializing it with all known dictionary services

Method Summary

Methods

Modifier and Type	Method and Description
protected Data.Value	convertDefaultValue(Data.DataType dataType, Object value) Convert Object value to respective DataType.
protected Data.Value	convertDefaultValue(Object value)
protected Data.DataType	convertDictionaryDataType(DataType dataType)
protected List<ConstraintMetadata>	getConstraints(FieldDefinition fd, String type, String state, String nextState, String workflowNode, String documentTypeName)
Metadata	getMetadata(String objectKey) This method gets the metadata for the given object key for state DRAFT.
Metadata	getMetadata(String objectKey, String state) This method gets the metadata for the given object key and state
Metadata	getMetadata(String objectKey, String type, String state) This method gets the metadata for the given object key, type and state
Metadata	getMetadata(String objectKey, String type, String state, String nextState, String documentTypeName) This method gets the metadata for the given object key, type, state and nextState
Metadata	getMetadataByWorkflowNode(String objectKey, String workflowNode, String documentTypeName) This method gets the metadata for the given object id key, workflowNode and documentTypeName
protected Metadata	getMetadataFromDictionaryService(String objectKey, String type, String state, String nextState, String workflowNode, String documentTypeName) This invokes the appropriate dictionary service to get the object structure and then converts it to a metadata structure.
protected ObjectStructureDefinition	getObjectStructure(String objectKey) This method gets the object structure for given objectKey from a dictionaryService
protected boolean	isRepeating(FieldDefinition fd) This method determines if a field is repeating
protected void	processCaseConstraint(ConstraintMetadata constraintMetadata, CaseConstraint caseConstraint, String type, String state, String nextState, String workflowNode) Currently this only handles requiredness indicators for case constraints with the following field paths: type, state, and proposal/workflowNode
void	setDictionaryServices(List<DictionaryService> dictionaryServices)
void	setUiLookupContext(String uiLookupContext)
protected void	updateConstraintMetadata(ConstraintMetadata constraintMetadata, Constraint constraint, String type, String state, String nextState, String workflowNode) This updates the constraintMetadata with defintions from the dictionary constraint field.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataServiceImpl

public MetadataServiceImpl()

MetadataServiceImpl

public MetadataServiceImpl(DictionaryService... dictionaryServices)

Create a metadata service initializing it with all known dictionary services

Parameters:

dictionaryServices -

Method Detail

setDictionaryServices

public void setDictionaryServices(List<DictionaryService> dictionaryServices)

getMetadata

public Metadata getMetadata(String objectKey,
                   String type,
                   String state,
                   String nextState,
                   String documentTypeName)

This method gets the metadata for the given object key, type, state and nextState

Parameters:

objectKey -

type - The type of the object (value can be null)

state - The state for which to retrieve object constraints (value can be null)

nextState - The state to to check requiredForNextState indicators (value can be null)

documentTypeName - The type of the document (value can be null)

Returns:

getMetadataByWorkflowNode

public Metadata getMetadataByWorkflowNode(String objectKey,
                                 String workflowNode,
                                 String documentTypeName)

This method gets the metadata for the given object id key, workflowNode and documentTypeName

Returns:

getMetadata

public Metadata getMetadata(String objectKey,
                   String type,
                   String state)

This method gets the metadata for the given object key, type and state

Parameters:

objectKey -

type - The type of the object (value can be null)

state - The state for which to retrieve object constraints (value can be null)

Returns:

getMetadata

public Metadata getMetadata(String objectKey,
                   String state)

This method gets the metadata for the given object key and state

Parameters:

objectKey -

state -

Returns:

getMetadata

public Metadata getMetadata(String objectKey)

This method gets the metadata for the given object key for state DRAFT.

Parameters:

objectKey -

Returns:

See Also:

getMetadata(String, String)

getMetadataFromDictionaryService

protected Metadata getMetadataFromDictionaryService(String objectKey,
                                        String type,
                                        String state,
                                        String nextState,
                                        String workflowNode,
                                        String documentTypeName)

This invokes the appropriate dictionary service to get the object structure and then converts it to a metadata structure.

Parameters:

objectKey -

type -

state -

documentTypeName -

Returns:

isRepeating

protected boolean isRepeating(FieldDefinition fd)

This method determines if a field is repeating

Parameters:

fd -

Returns:

getObjectStructure

protected ObjectStructureDefinition getObjectStructure(String objectKey)

This method gets the object structure for given objectKey from a dictionaryService

Parameters:

objectKey -

Returns:

getConstraints

protected List<ConstraintMetadata> getConstraints(FieldDefinition fd,
                                      String type,
                                      String state,
                                      String nextState,
                                      String workflowNode,
                                      String documentTypeName)

updateConstraintMetadata

protected void updateConstraintMetadata(ConstraintMetadata constraintMetadata,
                            Constraint constraint,
                            String type,
                            String state,
                            String nextState,
                            String workflowNode)

This updates the constraintMetadata with defintions from the dictionary constraint field.

Parameters:

constraintMetadata -

constraint -

processCaseConstraint

protected void processCaseConstraint(ConstraintMetadata constraintMetadata,
                         CaseConstraint caseConstraint,
                         String type,
                         String state,
                         String nextState,
                         String workflowNode)

Currently this only handles requiredness indicators for case constraints with the following field paths: type, state, and proposal/workflowNode

convertDefaultValue

protected Data.Value convertDefaultValue(Data.DataType dataType,
                             Object value)

Convert Object value to respective DataType. Method return null for object Value.

Parameters:

dataType -

value -

Returns:

convertDefaultValue

protected Data.Value convertDefaultValue(Object value)

convertDictionaryDataType

protected Data.DataType convertDictionaryDataType(DataType dataType)

setUiLookupContext

public void setUiLookupContext(String uiLookupContext)