Package org.odpi.openmetadata.frameworks.connectors.properties

Class RelatedAssetProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.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
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
RelatedAssetProperties is a base class for the asset information that returns null, for the asset's properties. Metadata repository implementations extend this class to add their implementation of the refresh() method that calls to the metadata repository to populate the metadata properties.

  • Constructor Details

    • 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 Details

    • 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, UserNotAuthorizedException
      Request 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:
      toString in class RelatedAsset
      Returns:
      print out of variables in a JSON-style