Class AsciiTableWriter
java.lang.Object
uk.ac.starlink.table.formats.DocumentedStreamStarTableWriter
uk.ac.starlink.table.formats.AbstractTextTableWriter
uk.ac.starlink.table.formats.AsciiTableWriter
- All Implemented Interfaces:
Documented, DocumentedIOHandler, StarTableWriter
A StarTableWriter which outputs text to a simple format machine-readable
text file. This format is suitable for reading using
AsciiStarTable and AsciiTableBuilder.- Since:
- 29 Mar 2004
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates whether the serialization of some (short) example table should be added to the user documentation for this handler.protected StringformatValue(Object val, ValueInfo vinfo, int width) Formats a data value for output.Returns "ascii".Returns user-directed documentation in XML format.protected voidprintColumnHeads(OutputStream strm, int[] colwidths, ColumnInfo[] cinfos) Outputs headings for the table columns.protected voidprintLine(OutputStream strm, int[] colwidths, String[] data) Outputs a line of table data.protected voidprintParam(OutputStream strm, String name, String value, Class<?> clazz) Outputs a parameter and its value.protected voidprintSeparator(OutputStream strm, int[] colwidths) Outputs a decorative separator line, of the sort you might find between the column headings and the table data.Methods inherited from class AbstractTextTableWriter
getBytes, getMaximumParameterLength, getMaxWidth, getMimeType, getMinNameWidth, getSampledRows, getWriteParameters, setMaximumParameterLength, setMaxWidth, setSampledRows, setWriteParameters, writeStarTableMethods inherited from class DocumentedStreamStarTableWriter
getExtensions, looksLikeFile, writeStarTableMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface DocumentedIOHandler
readText
-
Constructor Details
-
AsciiTableWriter
public AsciiTableWriter()
-
-
Method Details
-
formatValue
Description copied from class:AbstractTextTableWriterFormats a data value for output.- Specified by:
formatValuein classAbstractTextTableWriter- Parameters:
val- the valuevinfo- the metadata object describingval's typewidth- maximum preferred width into which the value should be formatted- Returns:
- formatted string meaning
value, preferably no longer thanwidthcharacters
-
getFormatName
Returns "ascii".- Specified by:
getFormatNamein interfaceStarTableWriter- Overrides:
getFormatNamein classAbstractTextTableWriter- Returns:
- output format
-
docIncludesExample
public boolean docIncludesExample()Description copied from interface:DocumentedIOHandlerIndicates whether the serialization of some (short) example table should be added to the user documentation for this handler. Binary formats, or instances for which theDocumented.getXmlDescription()method already includes some example output, should return false.- Returns:
- true if the user documentation would benefit from the addition of an example serialization
-
getXmlDescription
Description copied from interface:DocumentedReturns 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.
- Returns:
- XML description of this object
-
printSeparator
Description copied from class:AbstractTextTableWriterOutputs a decorative separator line, of the sort you might find between the column headings and the table data.- Specified by:
printSeparatorin classAbstractTextTableWriter- Parameters:
strm- stream to write intocolwidths- column widths in characters
-
printLine
Description copied from class:AbstractTextTableWriterOutputs a line of table data.- Specified by:
printLinein classAbstractTextTableWriter- Parameters:
strm- stream to write intocolwidths- column widths in charactersdata- array of strings to be output, one per column- Throws:
IOException
-
printColumnHeads
protected void printColumnHeads(OutputStream strm, int[] colwidths, ColumnInfo[] cinfos) throws IOException Description copied from class:AbstractTextTableWriterOutputs headings for the table columns.- Specified by:
printColumnHeadsin classAbstractTextTableWriter- Parameters:
strm- stream to write intocolwidths- column widths in characterscinfos- array of column headings- Throws:
IOException
-
printParam
protected void printParam(OutputStream strm, String name, String value, Class<?> clazz) throws IOException Description copied from class:AbstractTextTableWriterOutputs a parameter and its value.- Specified by:
printParamin classAbstractTextTableWriter- Parameters:
strm- stream to write intoname- parameter namevalue- formatted parameter valueclazz- type of value- Throws:
IOException
-