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

Class GlossaryTerm

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.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 org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
GlossaryTerm contains detailed descriptions about the meaning of a word or phrase.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryTerm()
    Default Constructor
    GlossaryTerm(GlossaryTerm template)
    Copy/clone Constructor - the resulting object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    String
    getAbbreviation()
    Return the abbreviation for this term (or null).
    String
    getDescription()
    Return the detailed description of the term's meaning.
    String
    getDisplayName()
    Return the display name for this term (normally a shortened form of the qualified name).
    String
    getExamples()
    Return example sentences that include this term.
    String
    getSummary()
    Return a short summary of the meaning of the term - used for summary lists of terms.
    String
    getUsage()
    Return instructions for how and when this term should be used.
    int
    hashCode()
    Return hash code for this object
    void
    setAbbreviation(String abbreviation)
    Set up the abbreviation for this term (or null).
    void
    setDescription(String description)
    Set up the detailed description of the term's meaning.
    void
    setDisplayName(String displayName)
    Set up the display name for this term (normally a shortened form of the qualified name).
    void
    setExamples(String examples)
    Set up example sentences that include this term.
    void
    setSummary(String summary)
    Set up a short summary of the meaning of the term - used for summary lists of terms.
    void
    setUsage(String usage)
    Set up instructions for how and when this term should be used.
    String
    toString()
    JSON-style toString

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

    getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

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

    getExtendedProperties, setExtendedProperties

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

    getClassifications, getGUID, setClassifications, setGUID

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

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

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

    getHeaderVersion, setHeaderVersion

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • 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 org.odpi.openmetadata.frameworks.connectors.properties.beans.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 org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
      Returns:
      int hash code