uk.ac.starlink.fits
Class BintableStarTable

java.lang.Object
  extended byuk.ac.starlink.table.AbstractStarTable
      extended byuk.ac.starlink.fits.BintableStarTable
All Implemented Interfaces:
StarTable

public abstract class BintableStarTable
extends AbstractStarTable

An implementation of the StarTable interface which uses a FITS BINTABLE extension. Reading is done into the random access data (possibly a mapped file); the nom.tam.fits classes are not used.

It is safe to read cells from different threads.


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.
 
Method Summary
 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.
static StarTable makeRandomStarTable(nom.tam.fits.Header hdr, nom.tam.util.RandomAccess rstream)
          Constructs a StarTable from a given random access stream.
static StarTable makeSequentialStarTable(nom.tam.fits.Header hdr, DataSource datsrc, long offset)
          Constructs a sequential-only StarTable from a DataSource.
 Object readCell(DataInput stream, int icol)
          Reads a cell from a given column from the current position in a stream.
 Object[] readRow(DataInput stream)
          Reads a whole row of the table from the current position in a stream, returning a new Object[] array.
 void readRow(DataInput stream, Object[] row)
          Reads a whole row of the table into an existing array.
static void streamStarTable(nom.tam.fits.Header hdr, DataInput stream, 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
 

Field Detail

TNULL_INFO

public static final ValueInfo TNULL_INFO
Column aux metadata key for TNULLn cards.


TSCAL_INFO

public static final ValueInfo TSCAL_INFO
Column aux metadata key for TSCALn cards.


TZERO_INFO

public static final ValueInfo TZERO_INFO
Column aux metadata key for TZEROn cards.


TDISP_INFO

public static final ValueInfo TDISP_INFO
Column aux metadata key for TDISPn cards.


TBCOL_INFO

public static final ValueInfo TBCOL_INFO
Column aux metadata key for TBCOLn cards.


TFORM_INFO

public static final ValueInfo TFORM_INFO
Column aux metadata key for TFORMn cards.

Method Detail

makeRandomStarTable

public static StarTable makeRandomStarTable(nom.tam.fits.Header hdr,
                                            nom.tam.util.RandomAccess rstream)
                                     throws nom.tam.fits.FitsException
Constructs a StarTable from a given random access stream.

Parameters:
hdr - FITS header descrbing the HDU
rstream - data stream positioned at the start of the data section of the HDU
Throws:
nom.tam.fits.FitsException

makeSequentialStarTable

public static StarTable makeSequentialStarTable(nom.tam.fits.Header hdr,
                                                DataSource datsrc,
                                                long offset)
                                         throws nom.tam.fits.FitsException
Constructs a sequential-only StarTable from a DataSource. Reading is deferred.

Parameters:
hdr - FITS header descrbing the HDU
datsrc - a data source which supplies the data stream containing the table data
offset - offset into the stream returned by datsrc at which the table data (not the corresponding HDU header) starts
Throws:
nom.tam.fits.FitsException

streamStarTable

public static void streamStarTable(nom.tam.fits.Header hdr,
                                   DataInput stream,
                                   TableSink sink)
                            throws nom.tam.fits.FitsException,
                                   IOException
Reads a BINTABLE extension from a stream and writes the result to a table sink.

Parameters:
hdr - FITS header object describing the BINTABLE extension
stream - input stream positioned at the start of the data part of the BINTABLE extension
sink - destination for the table
Throws:
nom.tam.fits.FitsException
IOException

getRowCount

public long getRowCount()
Description copied from interface: StarTable
Returns the number of rows in this table, if known. If the number of rows cannot be (easily) determined, a value of -1 will be returned.

Specified by:
getRowCount in interface StarTable
Specified by:
getRowCount in class AbstractStarTable

getColumnCount

public int getColumnCount()
Description copied from interface: StarTable
Returns the number of columns in this table.

Specified by:
getColumnCount in interface StarTable
Specified by:
getColumnCount in class AbstractStarTable

getColumnInfo

public ColumnInfo getColumnInfo(int icol)
Description copied from interface: StarTable
Returns the object describing the data in a given column.

Specified by:
getColumnInfo in interface StarTable
Specified by:
getColumnInfo in class AbstractStarTable

getColumnAuxDataInfos

public List getColumnAuxDataInfos()
Description copied from class: AbstractStarTable
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. Subclasses should override this if they can do better, for instance providing an order for the keys.

Specified by:
getColumnAuxDataInfos in interface StarTable
Overrides:
getColumnAuxDataInfos in class AbstractStarTable
Returns:
a list of all the auxiliary metadata ValueInfo items which in fact crop up in column metadata

readCell

public Object readCell(DataInput stream,
                       int icol)
                throws IOException
Reads a cell from a given column from the current position in a stream.

Parameters:
icol - the column index corresponding to the cell to be read
stream - a stream containing the byte data, positioned to the right place
Throws:
IOException

readRow

public Object[] readRow(DataInput stream)
                 throws IOException
Reads a whole row of the table from the current position in a stream, returning a new Object[] array.

Parameters:
stream - a stream containing the byte data, positioned to the right place
Returns:
ncol-element array of cells for this row
Throws:
IOException

readRow

public void readRow(DataInput stream,
                    Object[] row)
             throws IOException
Reads a whole row of the table into an existing array.

Parameters:
stream - a stream containing the byte data, positioned to the right place
row - ncol-element array, filled with row data on completion
Throws:
IOException

getRowLength

protected int getRowLength()
Returns the number of bytes occupied in the data stream by a single row of the table. This is equal to the sum of the column offsets array.

Returns:
row length in bytes

getColumnOffsets

protected int[] getColumnOffsets()
Returns the array of byte offsets from the start of the row at which each column starts.

Returns:
ncol-element array of byte offsets

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.