|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.votable.VOTableBuilder
Implementation of the TableBuilder interface which gets StarTables from VOTable documents.
Constructor Summary | |
VOTableBuilder()
Default constructor. |
|
VOTableBuilder(boolean strict)
Constructs a builder with explicit setting of whether VOTable standard interpreation is strict or not. |
Method Summary | |
boolean |
canImport(DataFlavor flavor)
Returns true for flavors which have MIME types starting text/xml application/xml application/x-votable+xml |
String |
getFormatName()
Returns the string "votable". |
StarTable |
makeStarTable(DataSource datsrc,
boolean wantRandom,
StoragePolicy storagePolicy)
Makes a StarTable out of a DataSource which points to a VOTable. |
StarTable[] |
makeStarTables(DataSource datsrc,
StoragePolicy storagePolicy)
Constructs an array of StarTables based on a given DataSource. |
void |
streamStarTable(InputStream istrm,
TableSink sink,
String index)
Acquires the data from a single TABLE element in a VOTable document, writing the result to a sink. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public VOTableBuilder()
VOElementFactory.isStrictByDefault()
.
public VOTableBuilder(boolean strict)
strict
- true iff you want strict enforcement of VOTable standardVOElementFactory.setStrict(boolean)
Method Detail |
public String getFormatName()
getFormatName
in interface TableBuilder
public StarTable makeStarTable(DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws TableFormatException, IOException
makeStarTable
in interface TableBuilder
datsrc
- the location of the VOTable document to usewantRandom
- whether, preferentially, a random access table
should be returned (doesn't guarantee that it will be random)storagePolicy
- a StoragePolicy object which may be used to
supply scratch storage if the builder needs it
IOException
- if an unexpected I/O error occurs during processing
TableFormatException
- if the table is not of a kind that
can be handled by this handlerpublic StarTable[] makeStarTables(DataSource datsrc, StoragePolicy storagePolicy) throws TableFormatException, IOException
MultiTableBuilder
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.
If the position
of the data source is not null,
then this method should return an array containing a single table,
the one which would be returned by the makeStarTable
method with that position.
makeStarTables
in interface MultiTableBuilder
datsrc
- the DataSource containing the table resourcestoragePolicy
- a StoragePolicy object which may be used to
supply scratch storage if the builder needs it
datsrc
TableFormatException
- if the table is not of a kind that
can be handled by this handler
IOException
- if an unexpected I/O error occurs during processingpublic boolean canImport(DataFlavor flavor)
canImport
in interface TableBuilder
flavor
- the DataFlavor whose suitability as stream input
is to be assessed
public void streamStarTable(InputStream istrm, TableSink sink, String index) throws IOException
For more flexible streamed access to VOTable data, use a
TableContentHandler
.
streamStarTable
in interface TableBuilder
istrm
- stream from which the VOTable document will be suppliedsink
- callback interface into which the table metadata and
data will be dumpedindex
- if present, a string representation of the index of
the table in the document to be read - "0" means the
first one encountered, "1" means the second, etc.
If it's null or not of numeric form the
first table will be used
IOException
- if some other error occurs
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |