com.adobe.dct.service
Interface DataDictionaryUtilService

public interface DataDictionaryUtilService

This defines all the utility apis for Data Dictionary, like, importing and exporting Data Dictionary into supported formats.

Method Summary

DataDictionaryInstance	createDataDictionaryInstance(String dataDictionaryName, Map ddiValues) This API creates a data dictionary instance(DDI to be used at runtime) corresponding to a Data Dictionary with data for the fields coming from passed in ddiValues map
DataDictionaryInstance	createDDInstanceFromPOJO(String dataDictionaryId, Object pojo) This API creates a Data Dictionary Instance (to be used at runtime) corresponding to a Data Dictionary with data for its child elements coming from input POJO
DataDictionaryInstance	createDDInstanceFromXml(String dataDictionaryName, String xml) This creates a data dictionary instance(DDI to be used at runtime) corresponding to a Data Dictionary with data for the fields coming from passed xml
String	exportDataDictionaryAsFML(String dataDictionaryId) This exports a data dictionary into a fiber model which can imported back to obtain the data dictionary.
DataDictionary	getDataDictionaryFromFML(String dataDictionaryName, String fml) Deprecated.
DataDictionary	getDataDictionaryFromFML2(String dataDictionaryName, String fml, String topLevelEntityName, String serviceName, String operationName) This API generates a data dictionary from the passed Fiber Model.
DataDictionary	getDataDictionaryFromXSD(String dataDictionaryName, String xmlSchema, String elementName) This generates a data dictionary from the passed XSD
DataDictionaryInstance	getDDIFromRemotingService(String dataDictionaryId, Object[] remotingServiceOperationParams) This API uses the LCDS Remoting Service details from the Data Dictionary and connects to the same for making a LCDS Remoting invocation.
String	getSampleXMLDataForDD(String dataDictionaryId) This generates a sample XML data which can be modified and passed for creating a data dictionary instance
boolean	hasCommonCollectionHierarchy(String dataDictionaryId, List listHavingListOfDDEDisplayNames) This API verifies whether the collection elements are used in appropriate hierarchy.
String	serializeDDItoXML(DataDictionaryInstance ddi) This generates a XML data representing the input Data Dictionary Instance

Method Detail

createDDInstanceFromXml

DataDictionaryInstance createDDInstanceFromXml(String dataDictionaryName,
                                               String xml)
                                               throws DCTException

This creates a data dictionary instance(DDI to be used at runtime) corresponding to a Data Dictionary with data for the fields coming from passed xml

Parameters:

dataDictionaryName - data dictionary name

xml - xml data

Returns:

data dictionary instance

Throws:

DCTException

createDataDictionaryInstance

DataDictionaryInstance createDataDictionaryInstance(String dataDictionaryName,
                                                    Map ddiValues)
                                                    throws DCTException

This API creates a data dictionary instance(DDI to be used at runtime) corresponding to a Data Dictionary with data for the fields coming from passed in ddiValues map

Parameters:

dataDictionaryName - data dictionary name

ddiValues - - Map containing the reference name versus values of the Data Dictionary elements

Returns:

DataDictionaryInstance

Throws:

DCTException

createDDInstanceFromPOJO

DataDictionaryInstance createDDInstanceFromPOJO(String dataDictionaryId,
                                                Object pojo)
                                                throws DCTException

This API creates a Data Dictionary Instance (to be used at runtime) corresponding to a Data Dictionary with data for its child elements coming from input POJO

Parameters:

dataDictionaryId - - Id of Data Dictionary for which DDI is to be constructed

pojo - - used to instantiate the DDI

Returns:

data dictionary instance

Throws:

DCTException

Since:

10.0.0.0

exportDataDictionaryAsFML

String exportDataDictionaryAsFML(String dataDictionaryId)
                                 throws DCTException

This exports a data dictionary into a fiber model which can imported back to obtain the data dictionary.

Parameters:

dataDictionaryId - data dictionary identifier

Returns:

exported Fiber Model corresponding to Data Dictionary

Throws:

DCTException

getDataDictionaryFromXSD

DataDictionary getDataDictionaryFromXSD(String dataDictionaryName,
                                        String xmlSchema,
                                        String elementName)
                                        throws DCTException

This generates a data dictionary from the passed XSD

Parameters:

dataDictionaryName - name by which the data dictionary is to be generated

xmlSchema - XSD for creating data dictionary

elementName - the top level element to be picked from XSD for creating data dictionary

Returns:

data dictionary

Throws:

DCTException

getDataDictionaryFromFML

@Deprecated
DataDictionary getDataDictionaryFromFML(String dataDictionaryName,
                                                   String fml)
                                        throws DCTException

Deprecated.

This API generates a data dictionary from the passed Fiber Model. It only supports the FML files which has been previously exported from the Data Dictionary building block. If any other FML is passed as input then this API throws appropriate exception. This API has been marked @deprecated as newer API getDataDictionaryFromFML2 has been introduced which also supports FML files retrieved from the Flash Builder.

Parameters:

dataDictionaryName - name by which the data dictionary is to be generated

fml - Fiber Model for creating data dictionary

Returns:

data dictionary

Throws:

DCTException

getDataDictionaryFromFML2

DataDictionary getDataDictionaryFromFML2(String dataDictionaryName,
                                         String fml,
                                         String topLevelEntityName,
                                         String serviceName,
                                         String operationName)
                                         throws DCTException

This API generates a data dictionary from the passed Fiber Model.

Parameters:

dataDictionaryName - - name by which the data dictionary is to be generated

fml - - Fiber Model for creating data dictionary

topLevelEntityName - - the top level entity to be picked from FML for creating data dictionary

serviceName - - is used to select the Service if there are more then one services defined in the FML.

operationName - - is used to select the Operation if there are more then one operations available in the selected Service..

Returns:

data dictionary

Throws:

DCTException

Since:

10.0.0.0

getSampleXMLDataForDD

String getSampleXMLDataForDD(String dataDictionaryId)
                             throws DCTException

This generates a sample XML data which can be modified and passed for creating a data dictionary instance

Parameters:

dataDictionaryId - data dictionary identifier

Returns:

sample XML corresponding to data dictionary

Throws:

DCTException

serializeDDItoXML

String serializeDDItoXML(DataDictionaryInstance ddi)
                         throws DCTException

This generates a XML data representing the input Data Dictionary Instance

Parameters:

Data - Dictionary Instance

Returns:

XML representing the Data Dictionary Instance

Throws:

DCTException

hasCommonCollectionHierarchy

boolean hasCommonCollectionHierarchy(String dataDictionaryId,
                                     List listHavingListOfDDEDisplayNames)
                                     throws DCTException

This API verifies whether the collection elements are used in appropriate hierarchy. Two important rules are applied in order to verify the same. First one is make sure that all collection elements at the same level have a common collection hierarchy. Second one is that the collection elements used at higher levels should extend the deepest element (as per Data Dictionary hierarchy) of the lower level.

Parameters:

dataDictionaryId - - is the ID of Data Dictionary for which the elements are to be validated

listHavingListsOfDDEDisplayNames - - list containing lists of DDE display names (at different levels)

Returns:

whether the collection elements are used in appropriate hierarchy

Throws:

DCTException

getDDIFromRemotingService

DataDictionaryInstance getDDIFromRemotingService(String dataDictionaryId,
                                                 Object[] remotingServiceOperationParams)
                                                 throws DCTException

This API uses the LCDS Remoting Service details from the Data Dictionary and connects to the same for making a LCDS Remoting invocation. The POJO obtained from the invocation is then used to create a Data Dictionary Instance.

Parameters:

dataDictionaryId - - Data Dictionary Id for which the Data Dictionary Instance is to be retrieved.

remotingServiceOperationParams - - These parameters are passed to the LCDS Remoting operation.

Returns:

DataDictionaryInstance

Throws:

DCTException

Since:

10.0.0.0