public class HapiTableBuilder extends DocumentedTableBuilder
include=header
.Constructor and Description |
---|
HapiTableBuilder() |
Modifier and Type | Method and Description |
---|---|
boolean |
canImport(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.
|
String |
getFormatName()
Returns the name of the format which can be read by this handler.
|
String |
getXmlDescription()
Returns user-directed documentation in XML format.
|
static boolean |
isMagic(byte[] buf)
Attempts to determine whether a stream contains a HAPI table
including header.
|
boolean |
looksLikeFile(String location)
Indicates whether the given location string is of a familiar form
for this builder.
|
StarTable |
makeStarTable(DataSource datsrc,
boolean wantRandom,
StoragePolicy storagePolicy)
Constructs a
StarTable based on a given DataSource . |
void |
streamStarTable(InputStream in,
TableSink sink,
String pos)
Reads a table from an input stream and writes it a row at a time
to a sink.
|
getExtensions
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
matchesExtension, readText, toLink
public boolean canStream()
DocumentedTableBuilder
canStream
in class DocumentedTableBuilder
public String getFormatName()
TableBuilder
public boolean looksLikeFile(String location)
TableBuilder
true
if there is
a good chance that a file with the given location
can be interpreted by this reader, for instance if it has a
suitable file extension.
This method may be used to guess, on a best-efforts basis, whether this builder is suitable for reading a file from a given location. Attempts may still be made to read inputs for which this method returns false. It is less important for builders that can recognise files by magic number, which is generally preferable to using filenames.
looksLikeFile
in interface TableBuilder
looksLikeFile
in class DocumentedTableBuilder
location
- the location string, such as a filename or URL
(not null)public boolean canImport(DataFlavor flavor)
TableBuilder
flavor
into a table.
It should return true
if it thinks that its
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[])
).
flavor
- the DataFlavor whose suitability as stream input
is to be assessedtrue
iff this builder reckons it stands a good
chance of turning a stream of type flavor
into a
StarTable
public boolean docIncludesExample()
DocumentedIOHandler
Documented.getXmlDescription()
method already includes some example output, should return false.public String getXmlDescription()
Documented
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 StarTable makeStarTable(DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws 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.
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 itdatsrc
TableFormatException
- if the table is not of a kind that
can be handled by this handlerIOException
- if an unexpected I/O error occurs during processingpublic void streamStarTable(InputStream in, TableSink sink, String pos) throws 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
.
in
- 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 malformedIOException
- if some other error occurspublic static boolean isMagic(byte[] buf)
Copyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.