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

Class Referenceable

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
Direct Known Subclasses:
Connection, ConnectorType, Endpoint
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.

  • 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

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the element. Null means that no displayName is available.
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for UIs and reports.
      Parameters:
      displayName - String name

    • setDescription

      public void setDescription(String description)
      Set up description of the element.
      Parameters:
      description - String

    • getDescription

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

    • 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

    • 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