TableBuilder
public class IpacTableBuilder extends java.lang.Object implements TableBuilder
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 | Description |
---|---|
IpacTableBuilder() |
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.
|
java.lang.String |
getFormatName() |
Returns "IPAC".
|
StarTable |
makeStarTable(uk.ac.starlink.util.DataSource datsrc,
boolean wantRandom,
StoragePolicy storagePolicy) |
Constructs a
StarTable 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.
|
public static final ValueInfo COMMENT_INFO
public java.lang.String getFormatName()
getFormatName
in interface TableBuilder
public boolean canImport(java.awt.datatransfer.DataFlavor flavor)
TableBuilder
TableBuilder.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 the
DataFlavor
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[])
).
canImport
in interface TableBuilder
flavor
- the DataFlavor whose suitability as stream input
is to be assessedpublic void streamStarTable(java.io.InputStream istrm, TableSink sink, java.lang.String pos) throws java.io.IOException
TableBuilder
TableFormatException
.
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.
streamStarTable
in interface TableBuilder
istrm
- input stream containing table datasink
- destination of the tablepos
- position identifier describing the location of the
table within the stream;
see DataSource.getPosition()
(may be null)TableFormatException
- if the table can't be streamed or
the data is malformedjava.io.IOException
- if some other error occurspublic StarTable makeStarTable(uk.ac.starlink.util.DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws java.io.IOException
TableBuilder
StarTable
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 a
TableFormatException
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 supplied
storagePolicy
, or any other resource-expensive measure,
to randomise a sequential table just because the
wantRandom
parameter is true.
makeStarTable
in interface TableBuilder
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 itTableFormatException
- 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 processingCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.