Package org.odpi.openmetadata.frameworks.governanceaction.converters

Class DataClassConverter<B>

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.converters.OpenMetadataConverterBase<B>

org.odpi.openmetadata.frameworks.governanceaction.converters.DataClassConverter<B>

public class DataClassConverter<B>
extends OpenMetadataConverterBase<B>

DataClassConverter generates a DataClassElement from a DataClass entity and related elements.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.converters.OpenMetadataConverterBase

propertyHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor	Description
DataClassConverter(PropertyHelper propertyHelper, String serviceName, String serverName)	Constructor

Method Summary

Modifier and Type	Method	Description
protected List<RelatedMetadataElementSummary>	getDataClassComposition(Class<B> beanClass, List<RelatedMetadataElement> relatedMetadataElements)	Summarize the elements linked off of the data class in specialization hierarchy.
protected List<RelatedMetadataElementSummary>	getDataClassHierarchy(Class<B> beanClass, List<RelatedMetadataElement> relatedMetadataElements)	Summarize the elements linked off of the data class in specialization hierarchy.
protected DataClassProperties	getDataClassProperties(OpenMetadataElement primaryElement)	Retrieve the data class properties from the retrieved element.
B	getNewBean(Class<B> beanClass, OpenMetadataElement primaryElement, String methodName)	Using the supplied instances, return a new instance of the bean.
B	getNewComplexBean(Class<B> beanClass, OpenMetadataElement primaryElement, List<RelatedMetadataElement> relationships, String methodName)	Using the supplied instances, return a new instance of the bean.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.converters.OpenMetadataConverterBase

getAbbreviation, getAdditionalValues, getAnchorGUID, getArguments, getAssetSummary, getAssociationDescription, getAttributeName, getAttribution, getCertificationGUID, getCertifiedBy, getClassificationProperties, getClassificationProperties, getConditions, getConfidence, getCustodian, getDataStoreEncoding, getDataStoreEncodingDescription, getDataStoreEncodingLanguage, getDescription, getDisplayName, getElementClassifications, getElementStub, getElementStub, getElementStub, getElementSummary, getEncodingProperties, getEncryption, getEnd, getFormat, getFormula, getFormulaType, getGroups, getGuard, getImplementationLanguage, getImplementationValue, getIsPublic, getLicensedBy, getLicensee, getLicenseGUID, getMetadataElementHeader, getMetadataElementHeader, getNewBean, getNewBean, getNewComplexBean, getNewComplexBean, getNewComplexBean, getNewComplexBean, getNewRelatedMetadataElementsBean, getNewSchemaAttributeBean, getNotes, getOriginBusinessCapabilityGUID, getOriginOrganizationGUID, getOtherOriginValues, getOwner, getPointType, getPosition, getQualifiedName, getQuery, getQueryId, getRationale, getRecipient, getReferenceId, getRelatedBy, getRelatedBy, getRelatedElementStub, getRelatedElementStub, getRelatedElementSummary, getRelationshipElements, getRemainingExtendedProperties, getSecurityLabels, getSecurityProperties, getStart, getSteward, getStewardPropertyName, getStewardTypeName, getStrictRequirement, getSummary, getSymbolicName, getUsage, getZoneMembership, handleBadEntity, handleBadRelatedMetadataElements, handleInvalidBeanClass, handleMissingMetadataInstance, handleUnexpectedBeanClass, handleUnimplementedConverterMethod, removeAbbreviation, removeActionProperties, removeActionRequested, removeActionSourceName, removeActionTargetName, removeAdditionalProperties, removeAliases, removeAllowsDuplicateValues, removeAnalysisParameters, removeAnalysisStep, removeAnchorGUID, removeAnnotationType, removeAssetGUID, removeAssociationType, removeAttachmentGUID, removeAttributeName, removeAuthor, removeAverageValue, removeBusinessImperatives, removeCandidateClassifications, removeCandidateDataClassGUIDs, removeCandidateGlossaryCategoryGUIDs, removeCandidateGlossaryTermGUIDs, removeCapabilityType, removeCapabilityVersion, removeCategory, removeClassificationName, removeClassificationPropertyName, removeClearPassword, removeCollectionType, removeComment, removeCommentText, removeCompletionDate, removeCompletionGuards, removeCompletionMessage, removeCompletionTime, removeConfidence, removeConfidenceLevel, removeConfigurationProperties, removeConnectorFrameworkName, removeConnectorInterfaceLanguage, removeConnectorInterfaces, removeConnectorProviderClassName, removeContactMethodService, removeContactMethodValue, removeContactType, removeCoordinates, removeCreatedTime, removeCreationTime, removeCriteria, removeDatabaseImportedFrom, removeDatabaseInstance, removeDataItemSortOrder, removeDataPatterns, removeDataType, removeDefaultValue, removeDefaultValueOverride, removeDeployedImplementationType, removeDescription, removeDesignStep, removeDetails, removeDisplayName, removeDistinguishedName, removeDomainIdentifier, removeDueTime, removeEmployeeNumber, removeEmployeeType, removeEncoding, removeEncodingStandard, removeEncryptedPassword, removeEncryptionMethod, removeEngineActionGUID, removeEstimatedVolumetrics, removeExamples, removeExecutorEngineGUID, removeExecutorEngineName, removeExpectedDataFormat, removeExplanation, removeExpression, removeExternalInstanceCreatedBy, removeExternalInstanceCreationTime, removeExternalInstanceLastUpdatedBy, removeExternalInstanceLastUpdateTime, removeExternalInstanceVersion, removeFileType, removeFixedValue, removeFormula, removeFormulaType, removeFullName, removeGivenNames, removeGuard, removeHeadCount, removeId, removeIdentifier, removeIgnoreMultipleTriggers, removeImplementationDescription, removeImplementationLanguage, removeImplications, removeImportance, removeInferredDataType, removeInferredFormat, removeInferredLength, removeInferredPrecision, removeInferredScale, removeInformalTerm, removeInformalTopic, removeInformationSupplyChainSegmentGUIDs, removeInitials, removeIntegrationStyle, removeIntPriority, removeIsCaseSensitive, removeIsDefaultValue, removeIsDeprecated, removeIsNullable, removeIsPublic, removeJobTitle, removeJsonProperties, removeJurisdiction, removeKarmaPoints, removeKeyword, removeLabel, removeLanguage, removeLastModifiedTime, removeLastModifier, removeLastReviewTime, removeLastSynchronized, removeLength, removeLevel, removeLevelIdentifier, removeMandatoryGuard, removeMappingProperties, removeMapProjection, removeMatchPropertyNames, removeMatchThreshold, removeMaxCardinality, removeMaximumInstances, removeMeasurement, removeMembershipRationale, removeMinCardinality, removeMinimumInstances, removeMinimumLength, removeMission, removeName, removeNamePatterns, removeNamespace, removeNativeClass, removeNetworkAddress, removeNotes, removeOperatingSystem, removeOperatingSystemPatchLevel, removeOrderedValues, removeOrderPropertyName, removeOrganization, removeOriginGovernanceEngine, removeOriginGovernanceService, removeOutcomes, removeOwner, removeOwnerPropertyName, removeOwnerTypeName, removeOwningOrganization, removeParameterType, removePatchLevel, removePathName, removePlannedDeployedImplementationType, removePlannedEndDate, removePosition, removePostalAddress, removePrecision, removePreferredLanguage, removePreferredValue, removeProcessingEngineUserId, removeProcessName, removeProfileCounts, removeProfileDates, removeProfileDoubles, removeProfileEndDate, removeProfileFlags, removeProfileProperties, removeProfilePropertyNames, removeProfileStartDate, removeProjectHealth, removeProjectPhase, removeProjectStatus, removePronouns, removeProtocol, removePublishVersionIdentifier, removePurpose, removePurposes, removeQualifiedName, removeQualityDimension, removeQualityScore, removeReceivedGuards, removeRecognizedAdditionalProperties, removeRecognizedConfigurationProperties, removeRecognizedSecuredProperties, removeReferenceId, removeReferenceVersion, removeRelatedEntityGUID, removeRelationshipProperties, removeRelationshipTypeName, removeRequesterUserId, removeRequestParameters, removeRequestSourceName, removeRequestType, removeRequired, removeResourceCreateTime, removeResourceLastAccessedTime, removeResourceProperties, removeResourceUpdateTime, removeResults, removeReview, removeReviewDate, removeRole, removeRoleTypeName, removeSampleValues, removeSchemaName, removeSchemaType, removeScope, removeSecuredProperties, removeServiceRequestType, removeSize, removeSolutionComponentType, removeSolutionPortDirection, removeSource, removeSpecification, removeSpecificationDetails, removeStartDate, removeSteward, removeStewardPropertyName, removeStewardTypeName, removeStoreCreateTime, removeStoreUpdateTime, removeSubjectAreaName, removeSummary, removeSupportedAssetTypeName, removeSurname, removeTagDescription, removeTagName, removeTarget, removeTargetTechnologyInterfaces, removeTargetTechnologyName, removeTargetTechnologySource, removeTargetTechnologyVersions, removeTeamRole, removeText, removeThreshold, removeTimeZone, removeTitle, removeToDoStatus, removeToDoType, removeTopicName, removeTopicType, removeTransformation, removeURL, removeUsage, removeUser, removeUserId, removeUsesBlockingCalls, removeValueCount, removeValueList, removeValueRangeFrom, removeValueRangeTo, removeVersionIdentifier, removeVersionNumber, removeWaitTime, removeZoneMembership, removeZoneName

Methods inherited from class java.lang.Object

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

Constructor Details

DataClassConverter

public DataClassConverter(PropertyHelper propertyHelper,
 String serviceName,
 String serverName)

Constructor

Parameters:

propertyHelper - helper object to parse entity

serviceName - name of this component

serverName - local server name

Method Details

getNewBean

public B getNewBean(Class<B> beanClass,
 OpenMetadataElement primaryElement,
 String methodName)
             throws PropertyServerException

Using the supplied instances, return a new instance of the bean. It is used for beans such as an Annotation or To Do bean which combine knowledge from the element and its linked relationships.

Overrides:

getNewBean in class OpenMetadataConverterBase<B>

Parameters:

beanClass - name of the class to create

primaryElement - element that is the root of the collection of entities that make up the content of the bean

methodName - calling method

Returns:

bean populated with properties from the instances supplied

Throws:

PropertyServerException - there is a problem instantiating the bean

getDataClassProperties

protected DataClassProperties getDataClassProperties(OpenMetadataElement primaryElement)

Retrieve the data class properties from the retrieved element.

Parameters:

primaryElement - element

Returns:

dataStructure properties

getDataClassHierarchy

protected List<RelatedMetadataElementSummary> getDataClassHierarchy(Class<B> beanClass,
 List<RelatedMetadataElement> relatedMetadataElements)
                                                             throws PropertyServerException

Summarize the elements linked off of the data class in specialization hierarchy.

Parameters:

beanClass - bean class

relatedMetadataElements - elements to summarize

Returns:

list or null

Throws:

PropertyServerException - problem in converter

getDataClassComposition

protected List<RelatedMetadataElementSummary> getDataClassComposition(Class<B> beanClass,
 List<RelatedMetadataElement> relatedMetadataElements)
                                                               throws PropertyServerException

Summarize the elements linked off of the data class in specialization hierarchy.

Parameters:

beanClass - bean class

relatedMetadataElements - elements to summarize

Returns:

list or null

Throws:

PropertyServerException - problem in converter

getNewComplexBean

public B getNewComplexBean(Class<B> beanClass,
 OpenMetadataElement primaryElement,
 List<RelatedMetadataElement> relationships,
 String methodName)
                    throws PropertyServerException

Using the supplied instances, return a new instance of the bean. It is used for beans such as an Annotation or To Do bean which combine knowledge from the element and its linked relationships.

Overrides:

getNewComplexBean in class OpenMetadataConverterBase<B>

Parameters:

beanClass - name of the class to create

primaryElement - element that is the root of the collection of entities that make up the content of the bean

relationships - relationships linking the entities

methodName - calling method

Returns:

bean populated with properties from the instances supplied

Throws:

PropertyServerException - there is a problem instantiating the bean