fact.io.hdureader

Class BinTableReader

java.lang.Object

fact.io.hdureader.BinTableReader

All Implemented Interfaces:

Reader, Iterable<OptionalTypesMap<String,Serializable>>, Iterator<OptionalTypesMap<String,Serializable>>

public class BinTableReader
extends Object
implements Reader

A reader for a FITS binary table.

This class implements the iterable and iterator interfaces which allow for such nice things as

for(OptionalTypesMap p : binTableReader){ assertTrue(p.containsKey("Data")); }

The next() and the getNextRow() methods deliver a map with the data from one row in the table.

Created by mackaiver on 18/11/16.

Method Summary

Modifier and Type	Method and Description
static BinTableReader	forBinTable(BinTable binTable)
OptionalTypesMap<String,Serializable>	getNextRow() Get the data from the next row.
boolean	hasNext() Check whether there is another row to return from this heap
void	skipRows(int amount) Skips the given number of rows.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fact.io.hdureader.Reader

iterator, next

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

hasNext

public boolean hasNext()

Check whether there is another row to return from this heap

Specified by:

hasNext in interface Reader

Specified by:

hasNext in interface Iterator<OptionalTypesMap<String,Serializable>>

Returns:

true if another row can be read.

forBinTable

public static BinTableReader forBinTable(BinTable binTable)

getNextRow

public OptionalTypesMap<String,Serializable> getNextRow()
                                                 throws IOException

Description copied from interface: Reader

Get the data from the next row. The columns in the row can be accessed by their name in the resulting map that is returned by this method. The resulting map comes with convenience methods for accessing data of predefined types.

Readers implementing this interface have to overwrite this method.

Specified by:

getNextRow in interface Reader

Returns:

a map containing the the data from the rows columns.

Throws:

IOException - if some IO error occurs

skipRows

public void skipRows(int amount)
              throws IOException

Skips the given number of rows.

Specified by:

skipRows in interface Reader

Parameters:

amount - The amount of rows to skip.

Throws:

IOException