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

Class Referenceable

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
Direct Known Subclasses:
Certification, Comment, Connection, ConnectorType, Endpoint, ExternalIdentifier, ExternalReference, GovernedReferenceable, License, Location, Note, NoteLogHeader, SoftwareCapability, ValidValue
public class Referenceable extends ElementBase
Many open metadata entities are referenceable. It means that they have a qualified name and additional properties. In addition, the Referenceable class adds support for the parent asset, guid, url and type for the entity through extending ElementBase.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    Referenceable()
    Default constructor
    Referenceable(Referenceable template)
    Copy/clone constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    Map<String,String>
    getAdditionalProperties()
    Return a copy of the additional properties.
    String
    getQualifiedName()
    Returns the stored qualified name property for the metadata entity.
    int
    hashCode()
    Return hash code based on properties.
    void
    setAdditionalProperties(Map<String,String> additionalProperties)
    Set up additional properties.
    void
    setQualifiedName(String qualifiedName)
    Set up the fully qualified name.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

    getExtendedProperties, setExtendedProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

    getClassifications, getGUID, setClassifications, setGUID

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Referenceable

      public Referenceable()
      Default constructor

    • Referenceable

      public Referenceable(Referenceable template)
      Copy/clone constructor. Retrieves the values from the supplied template
      Parameters:
      template - element to copy

  • Method Details

    • setQualifiedName

      public void setQualifiedName(String qualifiedName)
      Set up the fully qualified name.
      Parameters:
      qualifiedName - String name

    • getQualifiedName

      public String getQualifiedName()
      Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.
      Returns:
      qualifiedName

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up additional properties.
      Parameters:
      additionalProperties - Additional properties object

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return a copy of the additional properties. Null means no additional properties are available.
      Returns:
      AdditionalProperties

    • toString

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

    • hashCode

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