Package uk.ac.starlink.ttools.plot2.data
Class InputMeta
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.data.InputMeta
-
public class InputMeta extends java.lang.Object
Contains user-directed metadata to describe user-supplied input data coordinate values used for plots.A number of the setter methods return this object, to facilitate declarations where method invocations are chained so that the configured metadata object can be returned in a single expression rather than multiple statements (cf StringBuffer).
- Since:
- 12 Sep 2014
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description InputMeta(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 suitable for use in a GUI.java.lang.String
getShortDescription()
Returns a short description string.java.lang.String
getShortName()
Returns the basic one-word name, not case-sensitive, for use in command-line interfaces.java.lang.String
getValueUsage()
Returns a a short usage fragment that describes the form of the data values represented by this coordinate.java.lang.String
getXmlDescription()
Returns an XML string suitable for insertion into a user document.InputMeta
setShortDescription(java.lang.String shortDescription)
Sets a short description string.InputMeta
setValueUsage(java.lang.String usage)
Sets a usage string which should give some clue how to specify this key from a string.InputMeta
setXmlDescription(java.lang.String xmlDescription)
Sets a documentation string.InputMeta
setXmlDescription(java.lang.String[] lines)
Convenience method to set the XML description from an array of text lines.
-
-
-
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 suitable for use in a GUI.- Returns:
- long name
-
getValueUsage
public java.lang.String getValueUsage()
Returns a a short usage fragment that describes the form of the data values represented by this coordinate.Examples might be something like "
deg
" or "boolean
";- Returns:
- usage fragment
-
getShortDescription
public java.lang.String getShortDescription()
Returns a short description string.- Returns:
- one-line description
-
getXmlDescription
public java.lang.String getXmlDescription()
Returns an XML string suitable for insertion into a user document. It should be a sequence of one or more <p> elements. If null, the short description can be used instead.- Returns:
- XML string, or null
-
setValueUsage
public InputMeta setValueUsage(java.lang.String usage)
Sets a usage string which should give some clue how to specify this key from a string.Examples might be something like "
float
" or "boolean
";- Parameters:
usage
- usage string- Returns:
- this object, as a convenience
-
setShortDescription
public InputMeta setShortDescription(java.lang.String shortDescription)
Sets a short description string. This may be used as a prompt on the command line or a tooltip in a GUI. It should preferably be no longer than about 40 characters.- Parameters:
shortDescription
- one-line description- Returns:
- this object, as a convenience
-
setXmlDescription
public InputMeta setXmlDescription(java.lang.String xmlDescription)
Sets a documentation string. This is written in XML, intended for presentation as user documentation. The whole thing should be one or more <p> elements.Permissible elements include p, ul, li, dl, dt, dd, em, code, strong. Lists go inside paragraphs.
- Returns:
- documentation string
-
setXmlDescription
public InputMeta setXmlDescription(java.lang.String[] lines)
Convenience method to set the XML description from an array of text lines.setXmlDescription
is called on the result of joining the lines with newline characters.- Parameters:
lines
- lines of documentation string- Returns:
- this object, as a convenience
-
-