public class TextTableWriter extends AbstractTextTableWriter implements MultiStarTableWriter
Constructor and Description |
---|
TextTableWriter() |
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.
|
protected java.lang.String |
formatValue(java.lang.Object val,
ValueInfo vinfo,
int width)
Formats a data value for output.
|
java.lang.String |
getFormatName()
Returns "text";
|
java.lang.String |
getMimeType()
Returns a string suitable for use as the value of a MIME
Content-Type header.
|
java.lang.String |
getXmlDescription()
Returns user-directed documentation in XML format.
|
boolean |
looksLikeFile(java.lang.String location)
Returns true if the location argument is equal to "-",
indicating standard output.
|
protected void |
printColumnHeads(java.io.OutputStream strm,
int[] colwidths,
ColumnInfo[] cinfos)
Outputs headings for the table columns.
|
protected void |
printLine(java.io.OutputStream strm,
int[] colwidths,
java.lang.String[] data)
Outputs a line of table data.
|
protected void |
printParam(java.io.OutputStream strm,
java.lang.String name,
java.lang.String value,
java.lang.Class<?> clazz)
Outputs a parameter and its value.
|
protected void |
printSeparator(java.io.OutputStream strm,
int[] colwidths)
Outputs a decorative separator line, of the sort you might find
between the column headings and the table data.
|
void |
writeStarTables(TableSequence tableSeq,
java.io.OutputStream out)
Writes an array of StarTable objects to a given output stream.
|
void |
writeStarTables(TableSequence tableSeq,
java.lang.String location,
StarTableOutput sto)
Writes an array of StarTable objects to a given location.
|
getBytes, getMaximumParameterLength, getMaxWidth, getMinNameWidth, getSampledRows, getWriteParameters, setMaximumParameterLength, setMaxWidth, setSampledRows, setWriteParameters, writeStarTable
getExtensions, writeStarTable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
writeStarTable, writeStarTable
matchesExtension, readText, toLink
public java.lang.String getFormatName()
getFormatName
in interface StarTableWriter
getFormatName
in class AbstractTextTableWriter
public java.lang.String getMimeType()
StarTableWriter
application/octet-stream
"
(for binary formats) or "text/plain
" for ASCII ones)
is recommended.getMimeType
in interface StarTableWriter
getMimeType
in class AbstractTextTableWriter
public boolean docIncludesExample()
DocumentedIOHandler
Documented.getXmlDescription()
method already includes some example output, should return false.docIncludesExample
in interface DocumentedIOHandler
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 boolean looksLikeFile(java.lang.String location)
looksLikeFile
in interface StarTableWriter
looksLikeFile
in class DocumentedStreamStarTableWriter
location
- the location name (probably filename)public void writeStarTables(TableSequence tableSeq, java.io.OutputStream out) throws java.io.IOException
MultiStarTableWriter
BufferedOutputStream
), and should not close it at
the end of the call.writeStarTables
in interface MultiStarTableWriter
tableSeq
- sequence of tables to writeout
- destination streamjava.io.IOException
public void writeStarTables(TableSequence tableSeq, java.lang.String location, StarTableOutput sto) throws java.io.IOException
MultiStarTableWriter
writeStarTables
in interface MultiStarTableWriter
tableSeq
- sequence of tables to writelocation
- destination for tablessto
- StarTableOutput instancejava.io.IOException
protected java.lang.String formatValue(java.lang.Object val, ValueInfo vinfo, int width)
AbstractTextTableWriter
formatValue
in class AbstractTextTableWriter
val
- the valuevinfo
- the metadata object describing val's typewidth
- maximum preferred width into which the value should
be formattedprotected void printSeparator(java.io.OutputStream strm, int[] colwidths) throws java.io.IOException
AbstractTextTableWriter
printSeparator
in class AbstractTextTableWriter
strm
- stream to write intocolwidths
- column widths in charactersjava.io.IOException
protected void printColumnHeads(java.io.OutputStream strm, int[] colwidths, ColumnInfo[] cinfos) throws java.io.IOException
AbstractTextTableWriter
printColumnHeads
in class AbstractTextTableWriter
strm
- stream to write intocolwidths
- column widths in characterscinfos
- array of column headingsjava.io.IOException
protected void printLine(java.io.OutputStream strm, int[] colwidths, java.lang.String[] data) throws java.io.IOException
AbstractTextTableWriter
printLine
in class AbstractTextTableWriter
strm
- stream to write intocolwidths
- column widths in charactersdata
- array of strings to be output, one per columnjava.io.IOException
protected void printParam(java.io.OutputStream strm, java.lang.String name, java.lang.String value, java.lang.Class<?> clazz) throws java.io.IOException
AbstractTextTableWriter
printParam
in class AbstractTextTableWriter
strm
- stream to write intoname
- parameter namevalue
- formatted parameter valueclazz
- type of valuejava.io.IOException