Class ReportMeta


  • public class ReportMeta
    extends java.lang.Object
    Contains documentation metadata describing a plot report item.
    Since:
    9 Dec 2014
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      ReportMeta​(java.lang.String shortName, java.lang.String longName)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLongName()
      Returns a potentially more descriptive name for use in a GUI.
      java.lang.String getShortName()
      Returns the basic one-word name, not case-sensitive, for use in command-line interfaces.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReportMeta

        public ReportMeta​(java.lang.String shortName,
                          java.lang.String longName)
        Constructor.
        Parameters:
        shortName - basic name, no spaces, not case-sensitive, to be used in command-line interface
        longName - name for use in GUI
    • Method Detail

      • getShortName

        public java.lang.String getShortName()
        Returns the basic one-word name, not case-sensitive, for use in command-line interfaces.
        Returns:
        short name
      • getLongName

        public java.lang.String getLongName()
        Returns a potentially more descriptive name for use in a GUI.
        Returns:
        long name