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

Class Asset

  • All Implemented Interfaces:
    Serializable
    public class Asset
extends Referenceable
    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)
    • 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)
    • 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 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)
    • origin - 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:
    Serialized Form

    • Field Detail

      • displayName

        protected String displayName

      • shortDescription

        protected String shortDescription

      • description

        protected String description

      • owner

        protected String owner

      • ownerTypeName

        protected String ownerTypeName

      • ownerPropertyName

        protected String ownerPropertyName

      • zoneMembership

        protected List<String> zoneMembership

      • isReferenceData

        protected boolean isReferenceData

    • Constructor Detail

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

      • getDisplayName

        public String getDisplayName()
        Returns the stored display name property for the asset. If no display name is available then null 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

      • getShortDescription

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

      • setShortDescription

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

      • getDescription

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

      • setDescription

        public void setDescription​(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 OwnerType getOwnerType()
        Return the type of owner stored in the owner property.
        Returns:
        OwnerType enum

      • setOwnerType

        public void setOwnerType​(OwnerType ownerType)
        Set up the owner type for this asset.
        Parameters:
        ownerType - OwnerType 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

      • getOrigin

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

      • setOrigin

        public void setOrigin​(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

      • toString

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

      • hashCode

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