Class IpacTableBuilder
- java.lang.Object
-
- uk.ac.starlink.table.formats.DocumentedTableBuilder
-
- uk.ac.starlink.table.formats.IpacTableBuilder
-
- All Implemented Interfaces:
Documented
,DocumentedIOHandler
,TableBuilder
public class IpacTableBuilder extends DocumentedTableBuilder
A table builder which reads tables in IPAC format. The data format is defined at http://irsa.ipac.caltech.edu/applications/DDGEN/Doc/ipac_tbl.html.- Since:
- 7 Feb 2006
- Author:
- Mark Taylor
-
-
Field Summary
Fields Modifier and Type Field Description static ValueInfo
COMMENT_INFO
Parameter used for IPAC format comments, of which there may be many, one per line.
-
Constructor Summary
Constructors Constructor Description IpacTableBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canImport(java.awt.datatransfer.DataFlavor flavor)
Indicates whether this builder is able to turn a resource of media type indicated by flavor into a table.boolean
canStream()
Indicates whether this handler can read tables from a stream.boolean
docIncludesExample()
Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler.java.lang.String
getFormatName()
Returns "IPAC".java.lang.String
getXmlDescription()
Returns user-directed documentation in XML format.StarTable
makeStarTable(uk.ac.starlink.util.DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy)
Constructs aStarTable
based on a given DataSource.void
streamStarTable(java.io.InputStream istrm, TableSink sink, java.lang.String pos)
Reads a table from an input stream and writes it a row at a time to a sink.-
Methods inherited from class uk.ac.starlink.table.formats.DocumentedTableBuilder
getExtensions, looksLikeFile
-
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 Detail
-
COMMENT_INFO
public static final ValueInfo COMMENT_INFO
Parameter used for IPAC format comments, of which there may be many, one per line. This is represented as a single string with embedded newlines.
-
-
Method Detail
-
getFormatName
public java.lang.String getFormatName()
Returns "IPAC".- Returns:
- one-word description of this handler's format
-
canImport
public boolean canImport(java.awt.datatransfer.DataFlavor flavor)
Description copied from interface:TableBuilder
Indicates whether this builder is able to turn a resource of media type indicated by flavor into a table. It should return true if it thinks that itsTableBuilder.streamStarTable(java.io.InputStream, uk.ac.starlink.table.TableSink, java.lang.String)
method stands a reasonable chance of successfully constructing a StarTable from a DataSource whose input stream is described by theDataFlavor
flavor. It will typically make this determination based on the flavor's MIME type.This method should only return true if the flavor looks like it is targeted at this builder; for instance a builder which uses a text-based format should return false for a flavor which indicates a MIME type of text/plain.
This method is used in supporting drag and drop functionality (see
StarTableFactory.canImport(java.awt.datatransfer.DataFlavor[])
).- Parameters:
flavor
- the DataFlavor whose suitability as stream input is to be assessed- Returns:
- true iff this builder reckons it stands a good chance of turning a stream of type flavor into a StarTable
-
streamStarTable
public void streamStarTable(java.io.InputStream istrm, TableSink sink, java.lang.String pos) throws java.io.IOException
Description copied from interface:TableBuilder
Reads a table from an input stream and writes it a row at a time to a sink. Not all implementations will be able to do this; for instance, extracting the table from the data may be a two-pass process. Implementations which are unable to perform this function should throw aTableFormatException
.The input stream should be prepared for use prior to calling this method, so implementations should not in general attempt to decompress or buffer istrm.
- Parameters:
istrm
- input stream containing table datasink
- destination of the tablepos
- position identifier describing the location of the table within the stream; seeDataSource.getPosition()
(may be null)- Throws:
TableFormatException
- if the table can't be streamed or the data is malformedjava.io.IOException
- if some other error occurs
-
makeStarTable
public StarTable makeStarTable(uk.ac.starlink.util.DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws java.io.IOException
Description copied from interface:TableBuilder
Constructs aStarTable
based on a given DataSource. If the source is not recognised or this builder does not know how to construct a table from it, then aTableFormatException
should be thrown. If this builder thinks it should be able to handle the source but an error occurs during processing, an IOException can be thrown.The wantRandom parameter is used to indicate whether, ideally, a random-access table should be returned. There is no requirement for the builder to honour this request, but if it knows how to make both random and non-random tables, it can use this flag to decide which to return.
Note: the presence of the
wantRandom
parameter is somewhat misleading. TableBuilder implementations usually should, and do, ignore it (it would be removed from the interface if it were not for backward compatibility issues). Regardless of the value of this parameter, implementations should return a random-access table only if it is easy for them to do so; in particular they should not use the suppliedstoragePolicy
, or any other resource-expensive measure, to randomise a sequential table just because thewantRandom
parameter is true.- Parameters:
datsrc
- the DataSource containing the table resourcewantRandom
- whether, preferentially, a random access table should be returnedstoragePolicy
- a StoragePolicy object which may be used to supply scratch storage if the builder needs it- Returns:
- a StarTable made out of datsrc
- Throws:
TableFormatException
- if the table is not of a kind that can be handled by this handlerjava.io.IOException
- if an unexpected I/O error occurs during processing
-
canStream
public boolean canStream()
Description copied from class:DocumentedTableBuilder
Indicates whether this handler can read tables from a stream.- Specified by:
canStream
in classDocumentedTableBuilder
- Returns:
- true iff this handler can read from streams
-
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
-
-