fact.io.hdureader

Interface Reader

All Superinterfaces:

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

All Known Implementing Classes:

BinTableReader, ZFITSHeapReader

public interface Reader
extends Iterator<OptionalTypesMap<String,Serializable>>, Iterable<OptionalTypesMap<String,Serializable>>

A common interface for Readers for FITS and ZFitsTables. Readers (at least for bintables and zfits heaps) should implement methods for getting single rows from the file.

The Readers should be iterable so we have default methods for having nice for loops and things.

Created by mackaiver on 14/12/16.

Method Summary

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

next

default OptionalTypesMap<String,Serializable> next()
                                            throws NoSuchElementException

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.

This method overwrites the next() method of the iterable interface and is similar to the

Specified by:

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

Returns:

a map containing the the data from the rows columns.

Throws:

NoSuchElementException - iff hasNext() is false

See Also:

method but throws a runtime exception when an IO error occurs.

iterator

default Iterator<OptionalTypesMap<String,Serializable>> iterator()

Get the iterator for this Reader. This is useful for iterator style for loops i.e. for(Map m : reader){...}

Specified by:

iterator in interface Iterable<OptionalTypesMap<String,Serializable>>

Returns:

the iterator for this reader.

hasNext

boolean hasNext()

Check whether there is another row to return from this heap

Readers implementing this interface have to overwrite this method.

Specified by:

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

Returns:

true iff another row can be read.

getNextRow

OptionalTypesMap<String,Serializable> getNextRow()
                                          throws IOException

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.

Returns:

a map containing the the data from the rows columns.

Throws:

IOException - if some IO error occurs

skipRows

void skipRows(int amount)
       throws IOException

Skips the given number of rows.

Parameters:

num - The amount of rows to skip.

Throws:

IOException