Class RelatedAssetProperties
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedAsset
-
- org.odpi.openmetadata.frameworks.connectors.properties.RelatedAssetProperties
-
- All Implemented Interfaces:
Serializable
public abstract class RelatedAssetProperties extends RelatedAsset
RelatedAssetProperties returns detailed information about an asset that is related to an asset that is linked to the original anchor asset with a relationship. It is a generic interface for all types of open metadata assets. However, it assumes the asset's metadata model inherits from Asset (see model 0010 in Area 0). The RelatedAssetProperties returns metadata about the asset at three levels of detail:- assetSummary - used for displaying details of the asset in summary lists or hover text
- assetDetail - used to display all the information known about the asset with summaries of the relationships to other metadata entities
- assetUniverse - used to define the broader context for the asset
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected AssetUniverseassetProperties-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset
description, displayName, isReferenceData, name, origin, owner, ownerPropertyName, ownerType, ownerTypeName, shortDescription, versionIdentifier, zoneMembership
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
meanings, searchKeywords
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, qualifiedName
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties, url
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedRelatedAssetProperties()Default constructor used by subclassesRelatedAssetProperties(RelatedAsset relatedAsset)Typical constructor.RelatedAssetProperties(RelatedAssetProperties templateProperties)Copy/clone constructor*
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description AssetDetailgetAssetDetail()Returns detailed information about the asset organized in the assetDetail structure.AssetSummarygetAssetSummary()Returns the summary information organized in the assetSummary structure.AssetUniversegetAssetUniverse()Returns all the detail of the asset and information connected to it in organized in the assetUniverse structure.abstract voidrefresh()Request the values in the RelatedAssetProperties are refreshed with the current values from the metadata repository.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedAsset
equals, getAttributeName, getRelationshipName, hashCode, setAttributeName, setRelationshipName
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset
getAssetOrigin, getDescription, getDisplayName, getName, getOwner, getOwnerPropertyName, getOwnerType, getOwnerTypeName, getShortDescription, getVersionIdentifier, getZoneMembership, isReferenceData, setAssetOrigin, setDescription, setDisplayName, setName, setOwner, setOwnerPropertyName, setOwnerType, setOwnerTypeName, setReferenceData, setShortDescription, setVersionIdentifier, setZoneMembership
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
getMeanings, getSearchKeywords, setMeanings, setSearchKeywords
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, getURL, setExtendedProperties, setURL
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
-
-
-
Field Detail
-
assetProperties
protected AssetUniverse assetProperties
-
-
Constructor Detail
-
RelatedAssetProperties
protected RelatedAssetProperties()
Default constructor used by subclasses
-
RelatedAssetProperties
public RelatedAssetProperties(RelatedAsset relatedAsset)
Typical constructor.- Parameters:
relatedAsset- asset to extract the full set of properties.
-
RelatedAssetProperties
public RelatedAssetProperties(RelatedAssetProperties templateProperties)
Copy/clone constructor*- Parameters:
templateProperties- template to copy
-
-
Method Detail
-
getAssetSummary
public AssetSummary getAssetSummary()
Returns the summary information organized in the assetSummary structure.- Returns:
- AssetSummary summary object
-
getAssetDetail
public AssetDetail getAssetDetail()
Returns detailed information about the asset organized in the assetDetail structure.- Returns:
- AssetDetail detail object
-
getAssetUniverse
public AssetUniverse getAssetUniverse()
Returns all the detail of the asset and information connected to it in organized in the assetUniverse structure.- Returns:
- AssetUniverse universe object
-
refresh
public abstract void refresh() throws PropertyServerException, UserNotAuthorizedExceptionRequest the values in the RelatedAssetProperties are refreshed with the current values from the metadata repository.- Throws:
PropertyServerException- there is a problem connecting to the server to retrieve metadata.UserNotAuthorizedException- the userId associated with the connector is not authorized to access the asset properties.
-
toString
public String toString()
Standard toString method.- Overrides:
toStringin classRelatedAsset- Returns:
- print out of variables in a JSON-style
-
-