Package org.odpi.openmetadata.frameworks.openmetadata.properties.assets

Class AssetProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.SupplementaryProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties
Direct Known Subclasses:
APIProperties, AssetRequestBody, DataAssetProperties, ITInfrastructureProperties, ProcessProperties
public class AssetProperties extends SupplementaryProperties
AssetProperties holds asset properties that are used for displaying details of an asset in summary lists or hover text. It includes the following properties:
  • type - metadata type information for the asset
  • guid - globally unique identifier for the asset
  • url - external link for the asset
  • qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. (qualifiedName from Referenceable - model 0010)
  • displayName - A consumable name for the asset. Often a shortened form of the assetQualifiedName for use on user interfaces and messages. The assetDisplayName should only be used for audit logs and error messages if the assetQualifiedName is not set. (Sourced from attribute name within Asset - model 0010)
  • shortDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset - model 0205)
  • description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
  • classifications - list of all classifications assigned to the asset
  • extendedProperties - list of properties assigned to the asset from the Asset subclasses
  • additionalProperties - list of properties assigned to the asset as additional properties

  • Constructor Details

    • AssetProperties

      public AssetProperties()
      Default constructor

    • AssetProperties

      public AssetProperties(AssetProperties template)
      Copy/clone constructor. Note, this is a deep copy
      Parameters:
      template - object to copy

  • Method Details

    • cloneToAsset

      public AssetProperties cloneToAsset(String subTypeName)
      Convert this object into an AssetProperties object. This involves packing the properties introduced at this level into the extended properties.
      Parameters:
      subTypeName - subtype name
      Returns:
      asset properties

    • getName

      public String getName()
      Return the short name of the resource that is used when displaying the resource in tables etc.
      Returns:
      string

    • setName

      public void setName(String name)
      Set up the short name of the resource that is used in tables etc.
      Parameters:
      name - string resource name

    • getResourceName

      public String getResourceName()
      Return the full name of the resource as it is known in its owning technology.
      Returns:
      string

    • setResourceName

      public void setResourceName(String resourceName)
      Set up the full name of the resource as it is known in its owning technology.
      Parameters:
      resourceName - string

    • getDisplayName

      public String getDisplayName()
      Return the business oriented display name.
      Overrides:
      getDisplayName in class SupplementaryProperties
      Returns:
      display name

    • getVersionIdentifier

      public String getVersionIdentifier()
      Set up the version identifier of the resource.
      Returns:
      string version name

    • setVersionIdentifier

      public void setVersionIdentifier(String versionIdentifier)
      Set up the version identifier of the resource.
      Parameters:
      versionIdentifier - string version name

    • getResourceDescription

      public String getResourceDescription()
      Returns the stored description property extracted from the resource. If no description is provided then null is returned.
      Returns:
      description String text

    • setResourceDescription

      public void setResourceDescription(String resourceDescription)
      Set up the stored description property extracted from the resource.
      Parameters:
      resourceDescription - String text

    • getDisplayDescription

      public String getDisplayDescription()
      This override defaults the display description to the resource description if it is null;
      Overrides:
      getDisplayDescription in class SupplementaryProperties
      Returns:
      description

    • getDeployedImplementationType

      public String getDeployedImplementationType()
      Retrieve the name of the technology used for this data asset.
      Returns:
      string name

    • setDeployedImplementationType

      public void setDeployedImplementationType(String deployedImplementationType)
      Set up the name of the technology used for this data asset.
      Parameters:
      deployedImplementationType - string name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class SupplementaryProperties
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class SupplementaryProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class SupplementaryProperties
      Returns:
      int