public class TstTableWriter extends DocumentedStreamStarTableWriter
Constructor and Description |
---|
TstTableWriter() |
Modifier and Type | Method and Description |
---|---|
boolean |
docIncludesExample()
Indicates whether the serialization of some (short) example table
should be added to the user documentation for this handler.
|
String |
getFormatName()
Returns "TST".
|
String |
getMimeType()
Returns "text/plain".
|
String |
getXmlDescription()
Returns user-directed documentation in XML format.
|
void |
writeStarTable(StarTable st,
OutputStream out)
Writes a
StarTable object to a given output stream. |
getExtensions, looksLikeFile, writeStarTable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
matchesExtension, readText, toLink
public String getFormatName()
public String getMimeType()
public boolean docIncludesExample()
DocumentedIOHandler
Documented.getXmlDescription()
method already includes some example output, should return false.public 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.
public void writeStarTable(StarTable st, OutputStream out) throws IOException
StarTableWriter
StarTable
object to a given output stream.
The implementation can assume that out
is suitable for
direct writing (for instance it should not normally wrap it in a
BufferedOutputStream
), and should not close it
at the end of the call.
Not all table writers are capable of writing to a stream;
an implementation may throw a TableFormatException
to
indicate that it cannot do so.
st
- the table to writeout
- the output stream to which startab
should be
writtenTableFormatException
- if this table cannot be written to a
streamIOException
- if there is some I/O errorCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.