Package uk.ac.starlink.table.formats
Class IpacTableWriter
java.lang.Object
uk.ac.starlink.table.formats.DocumentedStreamStarTableWriter
uk.ac.starlink.table.formats.AbstractTextTableWriter
uk.ac.starlink.table.formats.IpacTableWriter
- All Implemented Interfaces:
Documented
,DocumentedIOHandler
,StarTableWriter
A StarTableWriter which writes to the IPAC text format.
The data format is defined at
http://irsa.ipac.caltech.edu/applications/DDGEN/Doc/ipac_tbl.html.
- Since:
- 20 Sep 2012
- Author:
- Mark Taylor
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler.formatValue
(Object val, ValueInfo info, int width) Formats a data value for output.Returns "IPAC".Returns "text/plain".int
getMinNameWidth
(ColumnInfo info) Returns the minimum width required to output the actual characters of the name for a given column.Returns user-directed documentation in XML format.void
printColumnHeads
(OutputStream out, int[] colwidths, ColumnInfo[] cinfos) Outputs headings for the table columns.protected void
printLine
(OutputStream out, int[] colwidths, String[] data) Outputs a line of table data.protected void
printParam
(OutputStream out, String name, String value, Class<?> clazz) Outputs a parameter and its value.protected void
printSeparator
(OutputStream out, 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 uk.ac.starlink.table.formats.AbstractTextTableWriter
getBytes, getMaximumParameterLength, getMaxWidth, getSampledRows, getWriteParameters, setMaximumParameterLength, setMaxWidth, setSampledRows, setWriteParameters, writeStarTable
Methods inherited from class uk.ac.starlink.table.formats.DocumentedStreamStarTableWriter
getExtensions, looksLikeFile, writeStarTable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface uk.ac.starlink.table.formats.DocumentedIOHandler
readText
-
Field Details
-
NULL
String representation for null values.
-
-
Constructor Details
-
IpacTableWriter
public IpacTableWriter()Constructor.
-
-
Method Details
-
getFormatName
Returns "IPAC".- Specified by:
getFormatName
in interfaceStarTableWriter
- Overrides:
getFormatName
in classAbstractTextTableWriter
- Returns:
- "text"
-
docIncludesExample
public boolean docIncludesExample()Description copied from interface:DocumentedIOHandler
Indicates 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: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.
- Returns:
- XML description of this object
-
getMimeType
Returns "text/plain".- Specified by:
getMimeType
in interfaceStarTableWriter
- Overrides:
getMimeType
in classAbstractTextTableWriter
- Returns:
- MIME content type
-
getMinNameWidth
Description copied from class:AbstractTextTableWriter
Returns the minimum width required to output the actual characters of the name for a given column. Padding applied subsequently by this object'sAbstractTextTableWriter.printColumnHeads(java.io.OutputStream, int[], uk.ac.starlink.table.ColumnInfo[])
method does not need to be included.- Overrides:
getMinNameWidth
in classAbstractTextTableWriter
- Parameters:
info
- column metadata- Returns:
- minimum number of characters required for column title
-
formatValue
Description copied from class:AbstractTextTableWriter
Formats a data value for output.- Specified by:
formatValue
in classAbstractTextTableWriter
- Parameters:
val
- the valueinfo
- the metadata object describingval
's typewidth
- maximum preferred width into which the value should be formatted- Returns:
- formatted string meaning
value
, preferably no longer thanwidth
characters
-
printColumnHeads
public void printColumnHeads(OutputStream out, int[] colwidths, ColumnInfo[] cinfos) throws IOException Description copied from class:AbstractTextTableWriter
Outputs headings for the table columns.- Specified by:
printColumnHeads
in classAbstractTextTableWriter
- Parameters:
out
- stream to write intocolwidths
- column widths in characterscinfos
- array of column headings- Throws:
IOException
-
printLine
Description copied from class:AbstractTextTableWriter
Outputs a line of table data.- Specified by:
printLine
in classAbstractTextTableWriter
- Parameters:
out
- stream to write intocolwidths
- column widths in charactersdata
- array of strings to be output, one per column- Throws:
IOException
-
printSeparator
Description copied from class:AbstractTextTableWriter
Outputs a decorative separator line, of the sort you might find between the column headings and the table data.- Specified by:
printSeparator
in classAbstractTextTableWriter
- Parameters:
out
- stream to write intocolwidths
- column widths in characters
-
printParam
protected void printParam(OutputStream out, String name, String value, Class<?> clazz) throws IOException Description copied from class:AbstractTextTableWriter
Outputs a parameter and its value.- Specified by:
printParam
in classAbstractTextTableWriter
- Parameters:
out
- stream to write intoname
- parameter namevalue
- formatted parameter valueclazz
- type of value- Throws:
IOException
-