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
public class IpacTableWriter extends AbstractTextTableWriter
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 Modifier and Type Field Description static java.lang.String
NULL
String representation for null values.
-
Constructor Summary
Constructors Constructor Description IpacTableWriter()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
docIncludesExample()
Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler.java.lang.String
formatValue(java.lang.Object val, ValueInfo info, int width)
Formats a data value for output.java.lang.String
getFormatName()
Returns "IPAC".java.lang.String
getMimeType()
Returns "text/plain".int
getMinNameWidth(ColumnInfo info)
Returns the minimum width required to output the actual characters of the name for a given column.java.lang.String
getXmlDescription()
Returns user-directed documentation in XML format.void
printColumnHeads(java.io.OutputStream out, int[] colwidths, ColumnInfo[] cinfos)
Outputs headings for the table columns.protected void
printLine(java.io.OutputStream out, int[] colwidths, java.lang.String[] data)
Outputs a line of table data.protected void
printParam(java.io.OutputStream out, java.lang.String name, java.lang.String value, java.lang.Class<?> clazz)
Outputs a parameter and its value.protected void
printSeparator(java.io.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
-
-
-
-
Method Detail
-
getFormatName
public java.lang.String 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
public java.lang.String 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
public java.lang.String getMimeType()
Returns "text/plain".- Specified by:
getMimeType
in interfaceStarTableWriter
- Overrides:
getMimeType
in classAbstractTextTableWriter
- Returns:
- MIME content type
-
getMinNameWidth
public int getMinNameWidth(ColumnInfo info)
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
public java.lang.String formatValue(java.lang.Object val, ValueInfo info, int width)
Description copied from class:AbstractTextTableWriter
Formats a data value for output.- Specified by:
formatValue
in classAbstractTextTableWriter
- Parameters:
val
- the valueinfo
- the metadata object describing val's typewidth
- maximum preferred width into which the value should be formatted- Returns:
- formatted string meaning value, preferably no longer than width characters
-
printColumnHeads
public void printColumnHeads(java.io.OutputStream out, int[] colwidths, ColumnInfo[] cinfos) throws java.io.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:
java.io.IOException
-
printLine
protected void printLine(java.io.OutputStream out, int[] colwidths, java.lang.String[] data) throws java.io.IOException
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:
java.io.IOException
-
printSeparator
protected void printSeparator(java.io.OutputStream out, int[] colwidths)
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(java.io.OutputStream out, java.lang.String name, java.lang.String value, java.lang.Class<?> clazz) throws java.io.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:
java.io.IOException
-
-