Package org.odpi.openmetadata.commonservices.generichandlers

Class ODFConverter<B>

java.lang.Object

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

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

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

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

ODFConverter 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

Constructor	Description
ODFConverter(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor

Method Summary

Modifier and Type	Method	Description
protected Annotation	getAnnotationBean(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 ElementHeader	getMetadataElementHeader(Class<B> beanClass, EntityDetail entity, String methodName)	Extract the properties from the entity.

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

getClassification, getEmbeddedConnection, getEntityClassifications, getOwnerTypeFromProperties, removeClassification, removeOwnerTypeFromProperties, removeSortOrder, setUpElementHeader, setUpElementHeader

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

getAbbreviation, getAdditionalValues, getAnchorGUID, getArguments, getAssetSummary, getAssociationDescription, getCertificationGUID, getCertifiedBy, getClassificationProperties, getClassificationProperties, getConditions, getConfidence, getCustodian, getDataStoreEncodingDescription, getDataStoreEncodingLanguage, getDataStoreEncodingType, getDescription, getDisplayName, getEncodingProperties, getEncryption, getEnd, getFormat, getFormula, getGroups, getGuard, getImplementationLanguage, getImplementationValue, getIsPublic, getLicensedBy, getLicensee, getLicenseGUID, getNewBean, getNewBean, getNewComplexBean, getNewComplexBean, getNewRelationshipBean, getNewSchemaAttributeBean, getNewSchemaTypeBean, getNewSchemaTypeBean, getNotes, getOriginBusinessCapabilityGUID, getOriginOrganizationGUID, getOtherOriginValues, getOwner, getOwnerPropertyName, getOwnerTypeName, getOwnerTypeOrdinal, getPointType, getPosition, getQualifiedName, getQuery, getQueryId, getRationale, getRecipient, getReferenceId, getRemainingExtendedProperties, getSecurityLabels, getSecurityProperties, getStart, getSteward, getStrictRequirement, getSummary, getSymbolicName, getUsage, getZoneMembership, handleBadEntity, handleBadEntityProxy, handleBadRelationship, handleInvalidBeanClass, handleMissingMetadataInstance, handleUnexpectedBeanClass, removeAbbreviation, removeActionProperties, removeActionRequested, removeActionTargetName, removeAdditionalProperties, removeAliases, removeAllowsDuplicateValues, removeAnalysisParameters, removeAnalysisStep, removeAnchorGUID, removeAnnotationType, removeAttachmentGUID, removeAuthor, removeAverageValue, removeBusinessImperatives, removeCandidateClassifications, removeCandidateDataClassGUIDs, removeCandidateGlossaryCategoryGUIDs, removeCandidateGlossaryTermGUIDs, removeCapabilityType, removeCapabilityVersion, removeClassificationName, removeClassificationPropertyName, removeClearPassword, removeComment, removeCommentText, removeCompletionDate, removeCompletionGuards, removeCompletionTime, removeConfidenceLevel, removeConfigurationProperties, removeConnectorFrameworkName, removeConnectorInterfaceLanguage, removeConnectorInterfaces, removeConnectorProviderClassName, removeContactMethodService, removeContactMethodValue, removeCoordinates, removeCreatedTime, removeCreationTime, removeCriteria, removeDatabaseImportedFrom, removeDatabaseInstance, removeDatabaseType, removeDatabaseVersion, removeDataFieldAliases, removeDataFieldDescription, removeDataFieldName, removeDataFieldType, removeDataSourceProperties, removeDataType, removeDefaultValue, removeDefaultValueOverride, removeDeployedImplementationType, removeDescription, removeDetails, removeDiscoveryActivity, removeDisplayName, removeDistinguishedName, removeDivergentClassificationName, removeDivergentClassificationPropertyNames, removeDivergentPropertyNames, removeDivergentRelationshipGUID, removeDivergentRelationshipPropertyNames, removeDomainIdentifier, removeDueTime, removeDuplicateAnchorGUID, removeDuplicateAnchorGUIDs, removeDuplicateAttachmentGUID, removeEmployeeNumber, removeEmployeeType, removeEncoding, removeEncodingStandard, removeEncryptedPassword, removeEncryptionMethod, removeExamples, removeExecutionDate, removeExecutorEngineGUID, removeExecutorEngineName, removeExpectedDataFormat, removeExplanation, removeExpression, removeFileType, removeFixedValue, removeFormula, removeFullName, removeGivenNames, removeGovernanceActionTypeGUID, removeGovernanceActionTypeName, removeHeadCount, removeId, removeIdentifier, removeImplementationDescription, removeImplementationLanguage, removeImplications, removeInferredDataType, removeInferredFormat, removeInferredLength, removeInferredPrecision, removeInferredScale, removeInformalTerm, removeInformalTopic, removeInitials, removeIntPriority, removeIsDeprecated, removeIsNullable, removeIsPublic, removeJobTitle, removeJsonProperties, removeJurisdiction, removeKarmaPoints, removeLanguage, removeLastModifiedTime, removeLastModifier, removeLastSynchronized, removeLength, removeLevel, removeLevelIdentifier, removeMandatoryGuards, removeMappingProperties, removeMapProjection, removeMatchingAttachmentGUIDs, removeMatchingClassificationNames, removeMatchingPropertyNames, removeMatchingRelationshipGUIDs, removeMaxCardinality, removeMaximumInstances, removeMembershipRationale, removeMinCardinality, removeMinimumInstances, removeMinimumLength, removeMission, removeName, removeNamespace, removeNativeClass, removeNetworkAddress, removeOperatingSystem, removeOperatingSystemPatchLevel, removeOrderedValues, removeOrderPropertyName, removeOrganization, removeOriginGovernanceEngine, removeOriginGovernanceService, removeOutcomes, removeOwner, removeOwnerPropertyName, removeOwnerTypeName, removeOwnerTypeOrdinal, removeParameterType, removePatchLevel, removePathName, removePlannedEndDate, removePosition, removePostalAddress, removePrecision, removePreferredLanguage, removePreferredValue, removePriority, removeProcessingEngineUserId, removeProcessName, removeProducedGuards, removeProfileCounts, removeProfileFlags, removeProfileProperties, removeProtocol, removeQualifiedName, removeQualityDimension, removeQualityScore, removeReceivedGuards, removeRecognizedAdditionalProperties, removeRecognizedConfigurationProperties, removeRecognizedSecuredProperties, removeReferenceId, removeReferenceVersion, removeRelatedEntityGUID, removeRelationshipProperties, removeRelationshipTypeName, removeRequestParameters, removeRequestSourceName, removeRequestType, removeRequired, removeResults, removeReview, removeReviewDate, removeRoleTypeName, removeSchemaName, removeSchemaType, removeScope, removeSecuredProperties, removeSize, removeSource, removeSourceCreateTime, removeSourceUpdateTime, removeStartDate, removeStatus, removeSteward, removeStoreCreateTime, removeStoreUpdateTime, removeSummary, removeSupportedAssetTypeName, removeSurname, removeTagDescription, removeTagName, removeTargetTechnologyInterfaces, removeTargetTechnologyName, removeTargetTechnologySource, removeTargetTechnologyVersions, removeText, removeTimeZone, removeTitle, removeTopicType, removeURL, 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

ODFConverter

public ODFConverter(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

getMetadataElementHeader

protected ElementHeader getMetadataElementHeader(Class<B> beanClass,
                                                 EntityDetail entity,
                                                 String methodName)
                                          throws PropertyServerException

Extract the properties from the entity.

Parameters:

beanClass - name of the class to create

entity - entity containing the properties

methodName - calling method

Returns:

filled out element header

Throws:

PropertyServerException - there is a problem in the use of the generic handlers because the converter has been configured with a type of bean that is incompatible with the handler

getAnnotationBean

protected Annotation getAnnotationBean(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 of bean that has been requested

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