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

Class Asset

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
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AssetSummary, RelatedAsset
public class Asset extends GovernedReferenceable
Asset 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)
  • resourceName - name extracted from the resource. (Sourced from attribute name within Asset - model 0010)
  • resourceDescription - description extracted from the resource. (Sourced from attribute description within Asset - model 0010)
  • displayName - A consumable name for the resource for use on user interfaces and messages. (Sourced from attribute displayName within GlossaryTerm - model 0330)
  • displaySummary - A short description of the resource for use on user interfaces and messages. (Sourced from attribute summary within GlossaryTerm - model 0330)
  • displayDescription - A full description of the resource in business terminology for use on user interfaces. (Sourced from attribute description within GlossaryTerm - model 0330)
  • abbreviation - A short name or acronym for the resource. (Sourced from attribute abbreviation within GlossaryTerm - model 0330)
  • usage - A description of how the resource is used by the business. (Sourced from attribute usage within GlossaryTerm - model 0330)
  • connectionDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset relationship - model 0205)
  • description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
  • owner - name of the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
  • ownerTypeName - name of the element type identifying the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
  • ownerPropertyName - name of the property identifying person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
  • ownerType - type of the person or organization that owns the asset. (Sourced from classification AssetOwnership attached to Asset - model 0445)
  • zoneMembership - name of the person or organization that owns the asset. (Sourced from classification AssetZoneMemberShip attached to Asset - model 0424)
  • assetOrigin - origin identifiers describing the source of the asset. (Sourced from classification AssetOrigin attached to Asset - model 0440)
  • latestChange - description of last update to the asset. (Sourced from classification LatestChange attached to Asset - model 0010)
  • isReferenceData - flag to show if asset contains reference data. (Sourced from classification ReferenceData within Asset - model 0524)
  • 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
See Also:

  • Field Details

    • resourceName

      protected String resourceName

    • resourceDescription

      protected String resourceDescription

    • versionIdentifier

      protected String versionIdentifier

    • displayName

      protected String displayName

    • displaySummary

      protected String displaySummary

    • displayDescription

      protected String displayDescription

    • abbreviation

      protected String abbreviation

    • usage

      protected String usage

    • connectionDescription

      protected String connectionDescription

    • owner

      protected String owner

    • ownerTypeName

      protected String ownerTypeName

    • ownerPropertyName

      protected String ownerPropertyName

    • ownerType

      protected AssetOwnerType ownerType

    • zoneMembership

      protected List<String> zoneMembership

    • origin

      protected Map<String,String> origin

    • isReferenceData

      protected boolean isReferenceData

    • name

      protected String name

    • description

      protected String description

  • Constructor Details

    • Asset

      public Asset()
      Default constructor

    • Asset

      public Asset(Asset template)
      Copy/clone constructor. Note, this is a deep copy
      Parameters:
      template - template values for asset summary

  • Method Details

    • getResourceName

      public String getResourceName()
      Return the name of the resource that this asset represents.
      Returns:
      string resource name

    • setResourceName

      public void setResourceName(String name)
      Set up the name of the resource that this asset represents.
      Parameters:
      name - string resource 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

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the asset. If no display name is available then resource name is returned.
      Returns:
      String name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the asset.
      Parameters:
      displayName - String name

    • getDisplaySummary

      public String getDisplaySummary()
      Return the short display description for tables and summaries.
      Returns:
      string description

    • setDisplaySummary

      public void setDisplaySummary(String displaySummary)
      Set up the short display description for tables and summaries.
      Parameters:
      displaySummary - string description

    • getDisplayDescription

      public String getDisplayDescription()
      Return the full business description.
      Returns:
      string description

    • setDisplayDescription

      public void setDisplayDescription(String displayDescription)
      Set up the full business description.
      Parameters:
      displayDescription - string description

    • getAbbreviation

      public String getAbbreviation()
      Return the abbreviation or acronym associated with the resources display name.
      Returns:
      string name

    • setAbbreviation

      public void setAbbreviation(String abbreviation)
      Set up the abbreviation or acronym associated with the resources display name.
      Parameters:
      abbreviation - string name

    • getUsage

      public String getUsage()
      Return the usage information for the resource. This typically describes how the organization uses the resource.
      Returns:
      string description

    • setUsage

      public void setUsage(String usage)
      Set up the usage information for the resource. This typically describes how the organization uses the resource.
      Parameters:
      usage - string description

    • getConnectionDescription

      public String getConnectionDescription()
      Returns the short description of the asset from relationship with Connection.
      Returns:
      shortDescription String

    • setConnectionDescription

      public void setConnectionDescription(String connectionDescription)
      Set up the short description of the asset from relationship with Connection.
      Parameters:
      connectionDescription - String text

    • getResourceDescription

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

    • setResourceDescription

      public void setResourceDescription(String description)
      Set up the stored description property associated with the asset.
      Parameters:
      description - String text

    • getOwner

      public String getOwner()
      Returns the name of the owner for this asset.
      Returns:
      owner String

    • setOwner

      public void setOwner(String owner)
      Set up the name of the owner for this asset.
      Parameters:
      owner - String name

    • getOwnerTypeName

      public String getOwnerTypeName()
      Returns the name of the type used to identify of the owner for this asset.
      Returns:
      owner String

    • setOwnerTypeName

      public void setOwnerTypeName(String ownerTypeName)
      Set up the name of the type used to identify the owner for this asset.
      Parameters:
      ownerTypeName - String name

    • getOwnerPropertyName

      public String getOwnerPropertyName()
      Returns the property name used to identify the owner for this asset.
      Returns:
      owner String

    • setOwnerPropertyName

      public void setOwnerPropertyName(String ownerPropertyName)
      Set up the property name used to identify the owner for this asset.
      Parameters:
      ownerPropertyName - String name

    • getOwnerType

      public AssetOwnerType getOwnerType()
      Return the type of owner stored in the owner property.
      Returns:
      AssetOwnerType enum

    • setOwnerType

      public void setOwnerType(AssetOwnerType ownerType)
      Set up the owner type for this asset.
      Parameters:
      ownerType - AssetOwnerType enum

    • getZoneMembership

      public List<String> getZoneMembership()
      Return the names of the zones that this asset is a member of.
      Returns:
      list of zone names

    • setZoneMembership

      public void setZoneMembership(List<String> zoneMembership)
      Set up the names of the zones that this asset is a member of.
      Parameters:
      zoneMembership - list of zone names

    • getAssetOrigin

      public Map<String,String> getAssetOrigin()
      Return the properties that characterize where this asset is from.
      Returns:
      map of name value pairs, all strings

    • setAssetOrigin

      public void setAssetOrigin(Map<String,String> origin)
      Set up the properties that characterize where this asset is from.
      Parameters:
      origin - map of name value pairs, all strings

    • isReferenceData

      public boolean isReferenceData()
      Return a boolean to see if the asset has been marked as reference data.
      Returns:
      true if the asset contains reference data

    • setReferenceData

      public void setReferenceData(boolean referenceData)
      Set up the boolean to see if the asset has been marked as reference data.
      Parameters:
      referenceData - true if the asset contains reference data

    • getName

      @Deprecated public String getName()
      Deprecated.
      Return the name of the resource that this asset represents.
      Returns:
      string resource name

    • setName

      @Deprecated public void setName(String name)
      Deprecated.
      Set up the name of the resource that this asset represents.
      Parameters:
      name - string resource name

    • getDescription

      @Deprecated public String getDescription()
      Deprecated.
      Returns the stored description property for the asset. If no description is provided then null is returned.
      Returns:
      description String text

    • setDescription

      @Deprecated public void setDescription(String description)
      Deprecated.
      Set up the stored description property associated with the asset.
      Parameters:
      description - String text

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class GovernedReferenceable
      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 GovernedReferenceable
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

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