|Constructor and Description|
|Modifier and Type||Method and Description|
Indicates whether this builder is able to turn a resource of media type indicated by flavor into a table.
Indicates whether this handler can read tables from a stream.
Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler.
Returns the name of the format which can be read by this handler.
Returns user-directed documentation in XML format.
Reads a table from an input stream and writes it a row at a time to a sink.
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public java.lang.String getFormatName()
public StarTable makeStarTable(DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws java.io.IOException
StarTablebased 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
TableFormatExceptionshould 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
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.
datsrc- the DataSource containing the table resource
wantRandom- whether, preferentially, a random access table should be returned
storagePolicy- a StoragePolicy object which may be used to supply scratch storage if the builder needs it
TableFormatException- if the table is not of a kind that can be handled by this handler
java.io.IOException- if an unexpected I/O error occurs during processing
public boolean canImport(java.awt.datatransfer.DataFlavor flavor)
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
DataFlavorflavor. 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
flavor- the DataFlavor whose suitability as stream input is to be assessed
public void streamStarTable(java.io.InputStream in, TableSink sink, java.lang.String pos) throws java.io.IOException
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.
in- input stream containing table data
sink- destination of the table
pos- 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 malformed
java.io.IOException- if some other error occurs
public java.lang.String getXmlDescription()
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.
public boolean canStream()
public boolean docIncludesExample()
Documented.getXmlDescription()method already includes some example output, should return false.