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

Class GlossaryTermProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermProperties
public class GlossaryTermProperties extends ReferenceableProperties
GlossaryTermProperties contains the semantic definition (meaning) of a word or phrase (term - collectively called terminology).

  • Constructor Details

    • GlossaryTermProperties

      public GlossaryTermProperties()
      Default constructor

    • GlossaryTermProperties

      public GlossaryTermProperties(GlossaryTermProperties template)
      Copy/clone constructor.
      Parameters:
      template - object to copy

  • Method Details

    • getDisplayName

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

    • getSummary

      public String getSummary()
      Return the short (1-2 sentence) description of the term.
      Returns:
      string text

    • setSummary

      public void setSummary(String summary)
      Set up the short (1-2 sentence) description of the term.
      Parameters:
      summary - string text

    • getDescription

      public String getDescription()
      Returns the stored description property for the term. 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 term.
      Parameters:
      description - String text

    • getExamples

      public String getExamples()
      Set up the description of one or more examples.
      Returns:
      string text

    • setExamples

      public void setExamples(String examples)
      Return the description of one or more examples.
      Parameters:
      examples - string text

    • getAbbreviation

      public String getAbbreviation()
      Return the abbreviation used for this term.
      Returns:
      string text

    • setAbbreviation

      public void setAbbreviation(String abbreviation)
      Set up the abbreviation used for this term.
      Parameters:
      abbreviation - string text

    • getUsage

      public String getUsage()
      Return details of the expected usage of this term.
      Returns:
      string text

    • setUsage

      public void setUsage(String usage)
      Set up details of the expected usage of this term.
      Parameters:
      usage - string text

    • getPublishVersionIdentifier

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

    • setPublishVersionIdentifier

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

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class ReferenceableProperties
      Returns:
      int hash code