Class MeaningProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class MeaningProperties
    extends ReferenceableProperties
    Meaning is a cut-down summary of a glossary term to aid in understanding the content of an element.
    See Also:
    Serialized Form
    • Constructor Detail

      • MeaningProperties

        public MeaningProperties()
        Default constructor
      • MeaningProperties

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

      • getDisplayName

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

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

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getExamples()
        Return example sentences that include this term.
        Returns:
        string examples
      • setExamples

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

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

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

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

        public void setUsage​(java.lang.String usage)
        Set up instructions for how and when this term should be used.
        Parameters:
        usage - string usage instructions
      • 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