|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.cdf.CdfTableBuilder
public class CdfTableBuilder
Table input handler for NASA CDF (Common Data Format) files.
Field Summary | |
---|---|
static CdfTableProfile |
DEFAULT_PROFILE
Default CDF-StarTable translation profile. |
Constructor Summary | |
---|---|
CdfTableBuilder()
Constructs a default Cdf table builder. |
|
CdfTableBuilder(CdfTableProfile profile)
Constructs a Cdf table builder with a custom translation profile. |
Method Summary | |
---|---|
boolean |
canImport(java.awt.datatransfer.DataFlavor flavor)
Returns false. |
static CdfTableProfile |
createProfile(boolean invarParams,
java.lang.String[] descripAttNames,
java.lang.String[] unitAttNames,
java.lang.String[] blankvalAttNames)
Constructs an instance of CdfTableProfile with some suggestions for attribute names with known semantics. |
java.lang.String |
getFormatName()
Returns "CDF". |
StarTable |
makeStarTable(DataSource datsrc,
boolean wantRandom,
StoragePolicy storagePolicy)
Constructs a StarTable based on a given DataSource. |
void |
streamStarTable(java.io.InputStream in,
TableSink sink,
java.lang.String pos)
Throws a TableFormatException. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final CdfTableProfile DEFAULT_PROFILE
Constructor Detail |
---|
public CdfTableBuilder()
public CdfTableBuilder(CdfTableProfile profile)
profile
- CDF-Startable translation profileMethod Detail |
---|
public java.lang.String getFormatName()
getFormatName
in interface TableBuilder
public StarTable makeStarTable(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 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 processingpublic boolean canImport(java.awt.datatransfer.DataFlavor flavor)
canImport
in interface TableBuilder
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
streamStarTable
in interface TableBuilder
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 malformed
java.io.IOException
- if some other error occurspublic static CdfTableProfile createProfile(boolean invarParams, java.lang.String[] descripAttNames, java.lang.String[] unitAttNames, java.lang.String[] blankvalAttNames)
invarParams
- true for turning non-row-varying variables into
table parameters, false for turning them into
variablesdescripAttNames
- ordered list of names of attributes
that might supply description metadataunitAttNames
- ordered list of names of attributes
that might supply units metadatablankvalAttNames
- ordered list of names of attributes
that might supply magic blank values
|
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 |