idare.imagenode.Interfaces.DataSetReaders.WorkBook

Interface IDARESheet

All Superinterfaces:

Iterable<IDARERow>

All Known Implementing Classes:

BasicIDARESheet, POISheet

public interface IDARESheet
extends Iterable<IDARERow>

An IDARESheet is a sheet containing multiple rows (i.e. entries for individual items) present in a given workbook. It commonly represents a unit such as all data from one experiment or one condition.

Author:

Thomas Pfau

Method Summary

Modifier and Type	Method and Description
int	getLastRowNum() Get the index of the last Row
int	getPhysicalNumberOfRows() Get the total number of non null rows in this Sheet.
IDARERow	getRow(int arg0) Get the Row with the provided row index
String	getSheetName() Get the Name of this Sheet.
Iterator<IDARERow>	rowIterator() Get an Iterator over all rows in this Sheet.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getLastRowNum

int getLastRowNum()

Get the index of the last Row

Returns:

the index of the last non null Row in this Sheet

getPhysicalNumberOfRows

int getPhysicalNumberOfRows()

Get the total number of non null rows in this Sheet.

Returns:

the number of non null rows in this sheet

getRow

IDARERow getRow(int arg0)

Get the Row with the provided row index

Parameters:

arg0 - the index for which a IDARERow is requested

Returns:

the requested Row or null, if it does not exist.

getSheetName

String getSheetName()

Get the Name of this Sheet.

Returns:

the name of this sheet.

rowIterator

Iterator<IDARERow> rowIterator()

Get an Iterator over all rows in this Sheet.

Returns:

The iterator iterating over all Rows in this sheet.