public class HapiTableScheme extends java.lang.Object implements TableScheme, Documented
Constructor and Description |
---|
HapiTableScheme() |
Modifier and Type | Method and Description |
---|---|
StarTable |
createTable(java.lang.String specification)
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.
|
public java.lang.String getSchemeName()
TableScheme
getSchemeName
in interface TableScheme
public java.lang.String getSchemeUsage()
TableScheme
getSchemeUsage
in interface TableScheme
public java.lang.String getExampleSpecification()
TableScheme
getExampleSpecification
in interface TableScheme
public java.lang.String getXmlDescription()
Documented
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.
getXmlDescription
in interface Documented
public StarTable createTable(java.lang.String specification) throws java.io.IOException
TableScheme
createTable
in interface TableScheme
specification
- scheme-specific table specification
(scheme name part is not included)TableFormatException
- if the format of the specification
is syntactically incorrect
(will typically provoke an error
containing the schemeUsage string)java.io.IOException
- if there is some other error in creating
the table