uk.ac.starlink.gbin
Class GbinTableReader

java.lang.Object
  uk.ac.starlink.gbin.GbinTableReader

All Implemented Interfaces:

RowSequence

public class GbinTableReader
extends Object
implements RowSequence

Does most of the work for turning a GbinObjectReader into a table.

Since:

14 Aug 2014

Constructor Summary

GbinTableReader(InputStream in, GbinTableProfile profile)
Constructor.

Method Summary

void	close() Indicates that this sequence will not be required any more.
Object	getCell(int icol) Returns the contents of a cell in the current row.
ColumnInfo[]	getColumnInfos() Returns the column metadata representing the columns this object will read.
String	getGaiaTableName() Returns the name of the table as known to the Gaia data model on the classpath, if any.
Class	getItemClass() Returns the class of the elements contained in the GBIN file.
Object[]	getRow() Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table.
boolean	next() Attempts to advances the current row to the next one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GbinTableReader

public GbinTableReader(InputStream in,
                       GbinTableProfile profile)
                throws IOException

Constructor.

Parameters:

in - input stream containing GBIN file

profile - configures details of table construction

Throws:

IOException

Method Detail

getColumnInfos

public ColumnInfo[] getColumnInfos()

Returns the column metadata representing the columns this object will read.

Returns:

array of metadata items, one for each column

getItemClass

public Class getItemClass()

Returns the class of the elements contained in the GBIN file. In fact it's just the class of the first one, but it's assumed the same for all.

Returns:

element class

getGaiaTableName

public String getGaiaTableName()

Returns the name of the table as known to the Gaia data model on the classpath, if any.

Returns:

well-known gaia table name, or null

next

public boolean next()
             throws IOException

Description copied from interface: RowSequence

Attempts to advances the current row to the next one. If true is returned the attempt has been successful, and if false is returned there are no more rows in this sequence. Since the initial position of a RowSequence is before the first row, this method must be called before current row data can be accessed using the RowSequence.getCell(int) or RowSequence.getRow() methods.

Specified by:

next in interface RowSequence

Returns:

true iff this sequence has been advanced to the next row

Throws:

IOException - if there is some error

getCell

public Object getCell(int icol)
               throws IOException

Description copied from interface: RowSequence

Returns the contents of a cell in the current row. The class of the returned object should be the same as, or a subclass of, the class returned by getColumnInfo(icol).getContentClass(). An unchecked exception will be thrown if there is no current row (next has not yet been called).

Specified by:

getCell in interface RowSequence

Returns:

the contents of cell icol in the current row

Throws:

IOException - if there is an error reading the data

getRow

public Object[] getRow()
                throws IOException

Description copied from interface: RowSequence

Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table. An unchecked exception will be thrown if there is no current row (next has not yet been called).

Specified by:

getRow in interface RowSequence

Returns:

an array of the objects in each cell in row irow

Throws:

IOException - if there is an error reading the data

close

public void close()
           throws IOException

Description copied from interface: RowSequence

Indicates that this sequence will not be required any more. This should release resources associated with this object. The effect of calling any of the other methods following a close is undefined.

Specified by:

close in interface RowSequence

Throws:

IOException