Class GlossaryTermProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class GlossaryTermProperties
    extends ReferenceableProperties
    GlossaryTermProperties contains the semantic definition (meaning) of a word or phrase (term - collectively called terminology).
    See Also:
    Serialized Form
    • Constructor Detail

      • GlossaryTermProperties

        public GlossaryTermProperties()
        Default constructor
      • GlossaryTermProperties

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

      • getDisplayName

        public java.lang.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​(java.lang.String displayName)
        Set up the stored display name property for the term.
        Parameters:
        displayName - String name
      • getSummary

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

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

        public java.lang.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​(java.lang.String description)
        Set up the stored description property for the term.
        Parameters:
        description - String text
      • getExamples

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

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

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

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

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

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

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

        public boolean equals​(java.lang.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