Class GlossaryProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class GlossaryProperties
    extends ReferenceableProperties
    GlossaryProperties is a class for representing a generic glossary.
    See Also:
    Serialized Form
    • Constructor Detail

      • GlossaryProperties

        public GlossaryProperties()
        Default constructor
      • GlossaryProperties

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

      • getDisplayName

        public java.lang.String getDisplayName()
        Return a human memorable name for the glossary.
        Returns:
        string name
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Set up a human memorable name for the glossary.
        Parameters:
        displayName - string name
      • getDescription

        public java.lang.String getDescription()
        Return the description of the glossary.
        Returns:
        string text
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up the description of the glossary.
        Parameters:
        description - string text
      • getLanguage

        public java.lang.String getLanguage()
        Return the language that the glossary contents are written in.
        Returns:
        string name
      • setLanguage

        public void setLanguage​(java.lang.String language)
        Set up the language that the glossary contents are written in.
        Parameters:
        language - string name
      • getUsage

        public java.lang.String getUsage()
        Return the expected usage of the glossary content.
        Returns:
        string description
      • setUsage

        public void setUsage​(java.lang.String usage)
        Set up the expected usage of the glossary content.
        Parameters:
        usage - string description
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class ReferenceableProperties
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison