public class EcsvTableBuilder extends DocumentedTableBuilder
| Constructor and Description |
|---|
EcsvTableBuilder()
Constructor.
|
| Modifier and Type | Method and 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 the name of the format which can be read by this handler.
|
java.lang.String |
getXmlDescription()
Returns user-directed documentation in XML format.
|
StarTable |
makeStarTable(DataSource datsrc,
boolean wantRandom,
StoragePolicy storagePolicy)
Constructs a
StarTable based on a given DataSource. |
void |
setColcheck(MessagePolicy colCheck) |
void |
setHeader(java.lang.String headerLoc)
Sets the location of a header file which will be prepended to
any file read by this handler.
|
void |
streamStarTable(java.io.InputStream in,
TableSink sink,
java.lang.String pos)
Reads a table from an input stream and writes it a row at a time
to a sink.
|
getExtensions, looksLikeFileclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitmatchesExtension, readText, toLinkpublic java.lang.String getFormatName()
TableBuilderpublic boolean canImport(java.awt.datatransfer.DataFlavor flavor)
TableBuilderTableBuilder.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 assessed@ConfigMethod(property="header", doc="<p>Location of a file containing a header to be applied\nto the start of the input file.\nBy using this you can apply your own ECSV-format metadata\nto plain CSV files.\n</p>", usage="<filename-or-url>", example="http://cdn.gea.esac.esa.int/Gaia/gedr3/ECSV_headers/gaia_source.header", sequence=1) public void setHeader(java.lang.String headerLoc)
headerLoc - filename or URL pointing to a header file@ConfigMethod(property="colcheck", doc="<p>Determines the action taken if the columns named\nin the YAML header differ from the columns named in the\nfirst line of the CSV part of the file.\n</p>", example="FAIL", sequence=2) public void setColcheck(MessagePolicy colCheck)
public void streamStarTable(java.io.InputStream in,
TableSink sink,
java.lang.String pos)
throws java.io.IOException
TableBuilderTableFormatException.
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 malformedjava.io.IOException - if some other error occurspublic StarTable makeStarTable(DataSource datsrc, boolean wantRandom, StoragePolicy storagePolicy) throws java.io.IOException
TableBuilderStarTable 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 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 processingpublic java.lang.String getXmlDescription()
DocumentedThe 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()
DocumentedTableBuildercanStream in class DocumentedTableBuilderpublic boolean docIncludesExample()
DocumentedIOHandlerDocumented.getXmlDescription()
method already includes some example output, should return false.