|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.AbstractStarTable
uk.ac.starlink.fits.BintableStarTable
public abstract class BintableStarTable
An implementation of the StarTable interface which uses a FITS BINTABLE extension. The nom.tam.fits classes are used for header parsing, but not for data access.
The implementation varies according to whether random or sequential-only access is provided by the underlying data access. A factory method is provided to create an appropriate instance.
Some instances of this class hang on to file descriptors.
If you are in danger of running out of that resource before
insstances are garbage collected, you can call the Closeable.close()
method to release them. Attempting to read data following
such a call may result in an exception.
Field Summary | |
---|---|
static ValueInfo |
TBCOL_INFO
Column aux metadata key for TBCOLn cards. |
static ValueInfo |
TDISP_INFO
Column aux metadata key for TDISPn cards. |
static ValueInfo |
TFORM_INFO
Column aux metadata key for TFORMn cards. |
static ValueInfo |
TNULL_INFO
Column aux metadata key for TNULLn cards. |
static ValueInfo |
TSCAL_INFO
Column aux metadata key for TSCALn cards. |
static ValueInfo |
TZERO_INFO
Column aux metadata key for TZEROn cards. |
Constructor Summary | |
---|---|
protected |
BintableStarTable(nom.tam.fits.Header hdr,
boolean isRandom)
Constructor. |
Method Summary | |
---|---|
static BintableStarTable |
createTable(nom.tam.fits.Header hdr,
InputFactory inputFact)
Returns an instance of this class given a data access instance. |
List |
getColumnAuxDataInfos()
Goes through the table columns (ColumnInfo objects) and picks out all the AuxData items which exist, generalising where necessary and returning a union of them in alphabetical order by name. |
int |
getColumnCount()
Returns the number of columns in this table. |
ColumnInfo |
getColumnInfo(int icol)
Returns the object describing the data in a given column. |
protected int[] |
getColumnOffsets()
Returns the array of byte offsets from the start of the row at which each column starts. |
long |
getRowCount()
Returns the number of rows in this table, if known. |
protected int |
getRowLength()
Returns the number of bytes occupied in the data stream by a single row of the table. |
protected Object |
readCell(BasicInput stream,
int icol)
Reads a cell from a given column from the current position in a stream. |
protected Object[] |
readRow(BasicInput stream)
Reads a whole row of the table from the current position in a stream, returning a new Object[] array. |
static void |
streamStarTable(nom.tam.fits.Header hdr,
BasicInput input,
TableSink sink)
Reads a BINTABLE extension from a stream and writes the result to a table sink. |
Methods inherited from class uk.ac.starlink.table.AbstractStarTable |
---|
checkedLongToInt, getCell, getName, getParameterByName, getParameters, getRow, getRowSequence, getURL, isRandom, setName, setParameter, setParameters, setURL |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.io.Closeable |
---|
close |
Field Detail |
---|
public static final ValueInfo TNULL_INFO
public static final ValueInfo TSCAL_INFO
public static final ValueInfo TZERO_INFO
public static final ValueInfo TDISP_INFO
public static final ValueInfo TBCOL_INFO
public static final ValueInfo TFORM_INFO
Constructor Detail |
---|
protected BintableStarTable(nom.tam.fits.Header hdr, boolean isRandom) throws nom.tam.fits.FitsException
hdr
- FITS header cardsisRandom
- true if the data access will be random-access,
false for sequential-only
nom.tam.fits.FitsException
Method Detail |
---|
public long getRowCount()
StarTable
getRowCount
in interface StarTable
getRowCount
in class AbstractStarTable
public int getColumnCount()
StarTable
getColumnCount
in interface StarTable
getColumnCount
in class AbstractStarTable
public ColumnInfo getColumnInfo(int icol)
StarTable
getColumnInfo
in interface StarTable
getColumnInfo
in class AbstractStarTable
icol
- the column for which header information is required
public List getColumnAuxDataInfos()
AbstractStarTable
getColumnAuxDataInfos
in interface StarTable
getColumnAuxDataInfos
in class AbstractStarTable
ColumnInfo.getAuxData()
protected Object readCell(BasicInput stream, int icol) throws IOException
icol
- the column index corresponding to the cell to be readstream
- a stream containing the byte data, positioned to
the right place
IOException
protected Object[] readRow(BasicInput stream) throws IOException
stream
- a stream containing the byte data, positioned to
the right place
IOException
protected int getRowLength()
protected int[] getColumnOffsets()
public static BintableStarTable createTable(nom.tam.fits.Header hdr, InputFactory inputFact) throws IOException, nom.tam.fits.FitsException
hdr
- FITS header cardsinputFact
- factory for access to the data part of the
HDU representing a FITS BINTABLE extension
IOException
nom.tam.fits.FitsException
public static void streamStarTable(nom.tam.fits.Header hdr, BasicInput input, TableSink sink) throws nom.tam.fits.FitsException, IOException
hdr
- FITS header object describing the BINTABLE extensioninput
- input stream positioned at the start of the
data part of the BINTABLE extensionsink
- destination for the table
nom.tam.fits.FitsException
IOException
|
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 |