Package uk.ac.starlink.table
Class LoopTableScheme
- java.lang.Object
-
- uk.ac.starlink.table.LoopTableScheme
-
- All Implemented Interfaces:
Documented
,TableScheme
public class LoopTableScheme extends java.lang.Object implements TableScheme, Documented
TableScheme that yields a table with a single column giving loop variable values.- Since:
- 20 Jul 2020
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description LoopTableScheme()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StarTable
createTable(java.lang.String spec)
Turns a scheme-specific specification into a table.java.lang.String
getExampleSpecification()
Returns a scheme-specific specification string suitable for use in examples.java.lang.String
getSchemeName()
Returns the name of this scheme.java.lang.String
getSchemeUsage()
Returns a short, plain-text usage string.java.lang.String
getXmlDescription()
Returns user-directed documentation in XML format.
-
-
-
Method Detail
-
getSchemeName
public java.lang.String getSchemeName()
Description copied from interface:TableScheme
Returns the name of this scheme. This string must be alphanumeric and should be short. It will be used between the colons in a table specification.- Specified by:
getSchemeName
in interfaceTableScheme
- Returns:
- scheme name
-
getSchemeUsage
public java.lang.String getSchemeUsage()
Description copied from interface:TableScheme
Returns a short, plain-text usage string. This should just represent the legal syntax for the specification string.- Specified by:
getSchemeUsage
in interfaceTableScheme
- Returns:
- usage syntax
-
getExampleSpecification
public java.lang.String getExampleSpecification()
Description copied from interface:TableScheme
Returns a scheme-specific specification string suitable for use in examples. It should return a table short enough to appear in textual documentation. If no suitable example is available, null may be returned.- Specified by:
getExampleSpecification
in interfaceTableScheme
- Returns:
- scheme-specific specification (scheme name part not included), or null
-
getXmlDescription
public java.lang.String getXmlDescription()
Description copied from interface:Documented
Returns user-directed documentation in XML format.The output should be a sequence of one or more <P> elements, using XHTML-like XML. Since rendering may be done in a number of contexts however, use of the full range of XHTML elements is discouraged. Where possible, the content should stick to simple markup such as the elements P, A, UL, OL, LI, DL, DT, DD EM, STRONG, I, B, CODE, TT, PRE.
- Specified by:
getXmlDescription
in interfaceDocumented
- Returns:
- XML description of this object
-
createTable
public StarTable createTable(java.lang.String spec) throws TableFormatException
Description copied from interface:TableScheme
Turns a scheme-specific specification into a table. In case of any error, an exception should be thrown.- Specified by:
createTable
in interfaceTableScheme
- Parameters:
spec
- scheme-specific table specification (scheme name part is not included)- Returns:
- created table, not null
- Throws:
TableFormatException
- if the format of the specification is syntactically incorrect (will typically provoke an error containing the schemeUsage string)
-
-