Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.properties

Class GlossaryTerm

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
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.properties.GlossaryTerm
public class GlossaryTerm extends Referenceable
GlossaryTerm contains detailed descriptions about the meaning of a word or phrase.

  • Constructor Details

    • GlossaryTerm

      public GlossaryTerm()
      Default Constructor

    • GlossaryTerm

      public GlossaryTerm(GlossaryTerm template)
      Copy/clone Constructor - the resulting object.
      Parameters:
      template - object being copied

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the display name for this term (normally a shortened form of the qualified name).
      Returns:
      string name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for this term (normally a shortened form of the qualified name).
      Parameters:
      displayName - string name

    • getSummary

      public String getSummary()
      Return a short summary of the meaning of the term - used for summary lists of terms.
      Returns:
      string description

    • setSummary

      public void setSummary(String summary)
      Set up a short summary of the meaning of the term - used for summary lists of terms.
      Parameters:
      summary - string description

    • getDescription

      public String getDescription()
      Return the detailed description of the term's meaning. This would be used where the term is the primary information being displayed.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the detailed description of the term's meaning. This would be used where the term is the primary information being displayed.
      Parameters:
      description - string description

    • getExamples

      public String getExamples()
      Return example sentences that include this term.
      Returns:
      string examples

    • setExamples

      public void setExamples(String examples)
      Set up example sentences that include this term.
      Parameters:
      examples - string examples

    • getAbbreviation

      public String getAbbreviation()
      Return the abbreviation for this term (or null).
      Returns:
      string abbreviation

    • setAbbreviation

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

    • getUsage

      public String getUsage()
      Return instructions for how and when this term should be used.
      Returns:
      string usage instructions

    • setUsage

      public void setUsage(String usage)
      Set up instructions for how and when this term should be used.
      Parameters:
      usage - string usage instructions

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Referenceable
      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 Referenceable
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

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