org.odpi.openmetadata.commonservices.generichandlers

Class OCFConverter<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericConverter<B>

org.odpi.openmetadata.commonservices.generichandlers.OCFConverter<B>

Direct Known Subclasses:

ConnectionConverter, ODFConverter

public abstract class OCFConverter<B>
extends OpenMetadataAPIGenericConverter<B>

DigitalArchitectureOMASConverter provides the generic methods for the Data Manager beans converters. Generic classes have limited knowledge of the classes these are working on and this means creating a new instance of a class from within a generic is a little involved. This class provides the generic method for creating and initializing a Data Manager bean.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericConverter

repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OCFConverter(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Constructor

Method Summary

Modifier and Type	Method and Description
protected ElementClassification	getClassification(String classificationName, List<ElementClassification> beanClassifications) Retrieve a specific named classification.
protected Connection	getEmbeddedConnection(Class<B> beanClass, EntityDetail primaryEntity, List<EntityDetail> supplementaryEntities, List<Relationship> relationships, String methodName) Using the supplied instances, return a new instance of the Connection bean.
protected List<ElementClassification>	getEntityClassifications(List<Classification> entityClassifications) Extract the classifications from the entity.
protected OwnerType	getOwnerTypeFromProperties(InstanceProperties properties) Retrieve the OwnerType enum property from the instance properties of a classification
protected List<ElementClassification>	removeClassification(String classificationName, List<ElementClassification> beanClassifications) Remove the requested classification from the bean classifications and return the resulting list.
protected OwnerType	removeOwnerTypeFromProperties(InstanceProperties properties) Retrieve and delete the OwnerType enum property from the instance properties of an entity
protected DataItemSortOrder	removeSortOrder(InstanceProperties instanceProperties) Extract and delete the sortOrder property from the supplied instance properties.
protected void	setUpElementHeader(ElementHeader elementHeader, EntityDetail entity, String expectedTypeName, String methodName) Extract the properties from the entity.
protected void	setUpElementHeader(ElementHeader elementHeader, InstanceHeader instanceHeader, List<Classification> classifications, String methodName) Extract the properties from the entity.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericConverter

getAdditionalValues, getAnchorGUID, getArguments, getAssetSummary, getAssociationDescription, getCertificationGUID, getCertifiedBy, getClassificationProperties, getClassificationProperties, getConditions, getConfidence, getCustodian, getDataStoreEncodingDescription, getDataStoreEncodingLanguage, getDataStoreEncodingType, getDescription, getDisplayName, getEncodingProperties, getEncryption, getEnd, getFormat, getFormula, getGuard, getImplementationLanguage, getImplementationValue, getIsPublic, getLicensedBy, getLicensee, getLicenseGUID, getNewBean, getNewBean, getNewComplexBean, getNewComplexBean, getNewRelationshipBean, getNewSchemaAttributeBean, getNewSchemaTypeBean, getNewSchemaTypeBean, getNotes, getOriginBusinessCapabilityGUID, getOriginOrganizationGUID, getOtherOriginValues, getOwner, getPosition, getQualifiedName, getRecipient, getRemainingExtendedProperties, getStart, getSteward, getStrictRequirement, getSymbolicName, getZoneMembership, handleInvalidBeanClass, handleMissingMetadataInstance, handleUnexpectedBeanClass, removeActionProperties, removeActionRequested, removeActionTargetName, removeAdditionalProperties, removeAliases, removeAllowsDuplicateValues, removeAnalysisParameters, removeAnalysisStep, removeAnchorGUID, removeAnnotationType, removeAttachmentGUID, removeAuthor, removeAverageValue, removeCandidateClassifications, removeCandidateDataClassGUIDs, removeCandidateGlossaryCategoryGUIDs, removeCandidateGlossaryTermGUIDs, removeCapabilityVersion, removeClearPassword, removeComment, removeCommentText, removeCompletionDate, removeCompletionGuards, removeConfidenceLevel, removeConfigurationProperties, removeConnectorProviderClassName, removeCoordinates, removeCriteria, removeDatabaseImportedFrom, removeDatabaseInstance, removeDatabaseType, removeDatabaseVersion, removeDataFieldAliases, removeDataFieldDescription, removeDataFieldName, removeDataFieldType, removeDataSourceProperties, removeDataType, removeDefaultValue, removeDefaultValueOverride, removeDeployedImplementationType, removeDescription, removeDiscoveryActivity, removeDisplayName, removeDivergentClassificationName, removeDivergentClassificationPropertyNames, removeDivergentPropertyNames, removeDivergentRelationshipGUID, removeDivergentRelationshipPropertyNames, removeDomainIdentifier, removeDuplicateAnchorGUID, removeDuplicateAnchorGUIDs, removeDuplicateAttachmentGUID, removeEncoding, removeEncodingStandard, removeEncryptedPassword, removeEncryptionMethod, removeExecutionDate, removeExplanation, removeExpression, removeFileType, removeFixedValue, removeFormula, removeIdentifier, removeImplementationLanguage, removeImplications, removeInferredDataType, removeInferredFormat, removeInferredLength, removeInferredPrecision, removeInferredScale, removeInformalTerm, removeInformalTopic, removeIsDeprecated, removeIsNullable, removeIsPublic, removeJsonProperties, removeLanguage, removeLastSynchronized, removeLength, removeLevel, removeMandatoryGuards, removeMappingProperties, removeMapProjection, removeMatchingAttachmentGUIDs, removeMatchingClassificationNames, removeMatchingPropertyNames, removeMatchingRelationshipGUIDs, removeMaxCardinality, removeMinCardinality, removeMinimumLength, removeName, removeNamespace, removeNativeClass, removeNetworkAddress, removeOrderedValues, removeOriginGovernanceEngine, removeOriginGovernanceService, removeOutcomes, removeOwner, removePatchLevel, removePathName, removePosition, removePostalAddress, removePrecision, removePreferredValue, removePriority, removeProcessingEngineUserId, removeProducedGuards, removeProfileCounts, removeProfileFlags, removeProfileProperties, removeProtocol, removeQualifiedName, removeQualityDimension, removeQualityScore, removeReceivedGuards, removeRecognizedAdditionalProperties, removeRecognizedConfigurationProperties, removeRecognizedSecuredProperties, removeRelatedEntityGUID, removeRelationshipProperties, removeRelationshipTypeName, removeRequestParameters, removeRequestSourceName, removeRequestType, removeResults, removeReview, removeReviewDate, removeSchemaName, removeSchemaType, removeScope, removeSecuredProperties, removeSize, removeSource, removeSourceCreateTime, removeSourceUpdateTime, removeStartDate, removeSteward, removeStoreCreateTime, removeStoreUpdateTime, removeSummary, removeTagDescription, removeTagName, removeTimeZone, removeTitle, removeUsage, removeUserId, removeValueCount, removeValueList, removeValueRangeFrom, removeValueRangeTo, removeVersionNumber, removeZoneMembership, validateInstanceType

Methods inherited from class java.lang.Object

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

Constructor Detail

OCFConverter

protected OCFConverter(OMRSRepositoryHelper repositoryHelper,
                       String serviceName,
                       String serverName)

Constructor

Parameters:

repositoryHelper - helper object to parse entity

serviceName - name of this component

serverName - name of this server

Method Detail

setUpElementHeader

protected void setUpElementHeader(ElementHeader elementHeader,
                                  EntityDetail entity,
                                  String expectedTypeName,
                                  String methodName)
                           throws PropertyServerException

Extract the properties from the entity.

Parameters:

elementHeader - the header for the bean

entity - entity containing the properties

expectedTypeName - type that the entity must match (or it may be a subtype)

methodName - calling method

Throws:

PropertyServerException - the supplied entity is not of the expected type

setUpElementHeader

protected void setUpElementHeader(ElementHeader elementHeader,
                                  InstanceHeader instanceHeader,
                                  List<Classification> classifications,
                                  String methodName)
                           throws PropertyServerException

Extract the properties from the entity.

Parameters:

elementHeader - the header for the bean

instanceHeader - header of entity

classifications - classifications from the entity

methodName - calling method

Throws:

PropertyServerException - the supplied entity is not of the expected type

getEntityClassifications

protected List<ElementClassification> getEntityClassifications(List<Classification> entityClassifications)

Extract the classifications from the entity.

Parameters:

entityClassifications - list of classifications from entity

Returns:

list of bean classifications

getClassification

protected ElementClassification getClassification(String classificationName,
                                                  List<ElementClassification> beanClassifications)

Retrieve a specific named classification.

Parameters:

classificationName - name of classification

beanClassifications - list of classifications retrieved from the repositories

Returns:

null or the requested classification

removeClassification

protected List<ElementClassification> removeClassification(String classificationName,
                                                           List<ElementClassification> beanClassifications)

Remove the requested classification from the bean classifications and return the resulting list.

Parameters:

classificationName - name of the classification

beanClassifications - list of classifications retrieved from the repositories

Returns:

null or a list of classifications

removeSortOrder

protected DataItemSortOrder removeSortOrder(InstanceProperties instanceProperties)

Extract and delete the sortOrder property from the supplied instance properties.

Parameters:

instanceProperties - properties from entity

Returns:

DataItemSortOrder enum

removeOwnerTypeFromProperties

protected OwnerType removeOwnerTypeFromProperties(InstanceProperties properties)

Retrieve and delete the OwnerType enum property from the instance properties of an entity

Parameters:

properties - entity properties

Returns:

OwnerType enum value

getOwnerTypeFromProperties

protected OwnerType getOwnerTypeFromProperties(InstanceProperties properties)

Retrieve the OwnerType enum property from the instance properties of a classification

Parameters:

properties - entity properties

Returns:

OwnerType enum value

getEmbeddedConnection

protected Connection getEmbeddedConnection(Class<B> beanClass,
                                           EntityDetail primaryEntity,
                                           List<EntityDetail> supplementaryEntities,
                                           List<Relationship> relationships,
                                           String methodName)
                                    throws PropertyServerException

Using the supplied instances, return a new instance of the Connection bean. It may be a Connection or a VirtualConnection.

Parameters:

beanClass - class name for the bean

primaryEntity - entity that is the root of the cluster of entities that make up the content of the bean

supplementaryEntities - entities connected to the primary entity by the relationships

relationships - relationships linking the entities

methodName - calling method

Returns:

bean populated with properties from the instances supplied in the constructor

Throws:

PropertyServerException - there is a problem instantiating the bean