idare.imagenode.Interfaces.DataSetReaders.WorkBook.BasicImplementation

Class BasicIDARESheet

java.lang.Object

idare.imagenode.Interfaces.DataSetReaders.WorkBook.BasicImplementation.BasicIDARESheet

All Implemented Interfaces:

IDARESheet, Iterable<IDARERow>

public class BasicIDARESheet
extends Object
implements IDARESheet

This is a basic implementation of a IDARESheet for convenience.

Author:

Thomas Pfau

Constructor Summary

Constructors

Constructor and Description
BasicIDARESheet(String sheetname) Default constructor using the name of the sheet.

Method Summary

Modifier and Type	Method and Description
BasicIDARERow	createRow() Create a row at the end of this sheet
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
int	getRowIndex(BasicIDARERow row) Get the index of a given Row
String	getSheetName() Get the Name of this Sheet.
Iterator<IDARERow>	iterator()
Iterator<IDARERow>	rowIterator() Get an Iterator over all rows in this Sheet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BasicIDARESheet

public BasicIDARESheet(String sheetname)

Default constructor using the name of the sheet.

Parameters:

sheetname - the name of this sheet.

Method Detail

iterator

public Iterator<IDARERow> iterator()

Specified by:

iterator in interface Iterable<IDARERow>

getLastRowNum

public int getLastRowNum()

Description copied from interface: IDARESheet

Get the index of the last Row

Specified by:

getLastRowNum in interface IDARESheet

Returns:

the index of the last non null Row in this Sheet

getPhysicalNumberOfRows

public int getPhysicalNumberOfRows()

Description copied from interface: IDARESheet

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

Specified by:

getPhysicalNumberOfRows in interface IDARESheet

Returns:

the number of non null rows in this sheet

getRow

public IDARERow getRow(int arg0)

Description copied from interface: IDARESheet

Get the Row with the provided row index

Specified by:

getRow in interface IDARESheet

Parameters:

arg0 - the index for which a IDARERow is requested

Returns:

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

getSheetName

public String getSheetName()

Description copied from interface: IDARESheet

Get the Name of this Sheet.

Specified by:

getSheetName in interface IDARESheet

Returns:

the name of this sheet.

rowIterator

public Iterator<IDARERow> rowIterator()

Description copied from interface: IDARESheet

Get an Iterator over all rows in this Sheet.

Specified by:

rowIterator in interface IDARESheet

Returns:

The iterator iterating over all Rows in this sheet.

createRow

public BasicIDARERow createRow()

Create a row at the end of this sheet

Returns:

the created Row.

getRowIndex

public int getRowIndex(BasicIDARERow row)

Get the index of a given Row

Parameters:

row - The BasicIDARERow to get the index for.

Returns:

the index of the given row.