Package org.odpi.openmetadata.frameworks.integration.bitol.mapping

Class DataContractGenerator

java.lang.Object

org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolGeneratorBase

org.odpi.openmetadata.frameworks.integration.bitol.mapping.DataContractGenerator

public class DataContractGenerator
extends BitolGeneratorBase

DataContractGenerator builds an Open Data Contract Standard (ODCS) document from an Agreement in open metadata. It is the reverse of DataContractMapper: the agreement's data structures become schema objects, their data fields become properties (with nested fields and array items, classifications and linked fields), the data quality rules governing a structure or field become its quality checks, the service level objective governing the agreement becomes the SLA properties, the endpoints listed as resources become servers, and the security roles associated with the agreement's access control become the access roles.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolGeneratorBase

context, propertyHelper

Constructor Summary

Constructors

Constructor	Description
DataContractGenerator(ConnectorContextBase context)	Constructor.

Method Summary

Modifier and Type	Method	Description
DataContract	generateDataContract(String agreementGUID)	Generate the ODCS document for an agreement.
DataContract	generateDataContract(OpenMetadataRootElement agreement)	Generate the ODCS document for an agreement that has already been retrieved with its related elements.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolGeneratorBase

fillFundamentals, fromJSON, fromJSONList, getAuthoritativeDefinitions, getBitolValue, getContext, getCustomProperties, getDeprecated, getDisplayName, getGUID, getSupportChannels, getSynonyms, getTags, getTeam, getTenant, getTypeName

Methods inherited from class java.lang.Object

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

Constructor Details

DataContractGenerator

public DataContractGenerator(ConnectorContextBase context)

Constructor.

Parameters:

context - connector context providing access to the open metadata clients

Method Details

generateDataContract

public DataContract generateDataContract(String agreementGUID)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Generate the ODCS document for an agreement.

Parameters:

agreementGUID - unique identifier of the Agreement element

Returns:

document

Throws:

InvalidParameterException - the element is not an agreement

PropertyServerException - problem with the metadata store

UserNotAuthorizedException - security problem

generateDataContract

public DataContract generateDataContract(OpenMetadataRootElement agreement)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Generate the ODCS document for an agreement that has already been retrieved with its related elements.

Parameters:

agreement - Agreement element

Returns:

document

Throws:

InvalidParameterException - the element is not an agreement

PropertyServerException - problem with the metadata store

UserNotAuthorizedException - security problem