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

Class ReferenceableProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.EntityProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
Direct Known Subclasses:
ActorProperties, AssetProperties, AuthoredReferenceableProperties, CommentProperties, CommunityProperties, ConnectionProperties, ConnectorTypeProperties, ContactDetailsProperties, ContextEventProperties, ContributionRecordProperties, EndpointProperties, EngineActionElement, ExternalIdProperties, GovernanceActionType, InformalTagProperties, LocationProperties, MetadataRepositoryCohortProperties, NoteLogProperties, PortProperties, PropertyFacetProperties, SoftwareCapabilityProperties
public class ReferenceableProperties extends OpenMetadataRootProperties
Many open metadata entities are referenceable. It means that they have a qualified name and additional properties.

  • Constructor Details

    • ReferenceableProperties

      public ReferenceableProperties()
      Default constructor

    • ReferenceableProperties

      public ReferenceableProperties(ReferenceableProperties template)
      Copy/clone constructor. Retrieves 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

    • getIdentifier

      public String getIdentifier()
      Return the code value or symbol used to identify the element - typically unique.
      Returns:
      string identifier

    • setIdentifier

      public void setIdentifier(String identifier)
      Set up the code value or symbol used to identify the element - typically unique.
      Parameters:
      identifier - string identifier

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the element. 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 element.
      Parameters:
      displayName - String name

    • getDescription

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

    • setDescription

      public void setDescription(String description)
      Set up the stored description property for the element.
      Parameters:
      description - String text

    • getVersionIdentifier

      public String getVersionIdentifier()
      Return the author-controlled version identifier.
      Returns:
      version identifier

    • setVersionIdentifier

      public void setVersionIdentifier(String versionIdentifier)
      Set up the author-controlled version identifier.
      Parameters:
      versionIdentifier - version identifier

    • getCategory

      public String getCategory()
      Return a descriptive name for the element's category.
      Returns:
      string name

    • setCategory

      public void setCategory(String category)
      Set up a descriptive name for the element's category. This field can be used to group related elements together that are used for the same activity, event through they may be different types.
      Parameters:
      category - string name

    • getURL

      public String getURL()
      Return the URL used to retrieve the resource that this external reference represents.
      Returns:
      String URI

    • setURL

      public void setURL(String uri)
      Set up the URI used to retrieve the resource that this external reference represents.
      Parameters:
      uri - String URI

    • 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 OpenMetadataRootProperties
      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 OpenMetadataRootProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

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