idare.imagenode.Interfaces.DataSetReaders.WorkBook.BasicImplementation

Class BasicIDARERow

java.lang.Object

idare.imagenode.Interfaces.DataSetReaders.WorkBook.BasicImplementation.BasicIDARERow

All Implemented Interfaces:

IDARERow, Iterable<IDARECell>

public class BasicIDARERow
extends Object
implements IDARERow

A simple implementation of an IDARERow

Author:

Thomas Pfau

Field Summary

Fields inherited from interface idare.imagenode.Interfaces.DataSetReaders.WorkBook.IDARERow

CREATE_NULL_AS_BLANK, RETURN_BLANK_AS_NULL, RETURN_NULL_AND_BLANK

Constructor Summary

Constructors

Constructor and Description
BasicIDARERow(BasicIDARESheet parent) Simple constructor providing the parent sheet.

Method Summary

Modifier and Type	Method and Description
Iterator<IDARECell>	cellIterator() Obtain an Iterator over the IDARECells of this row.
BasicIDARECell	createCell() Create a Blank Cell at the end of this row.
BasicIDARECell	createCell(IDARECell.CellType type) Create a Cell with a specified type at the end of this row This is the same as a call to createCell(type,getLastCellNum()-1)
BasicIDARECell	createCell(IDARECell.CellType CellType, int pos) Create a Cell of the specified type at the specified position.
BasicIDARECell	createCell(int pos) Create a blank cell at a specified position, overwriting any cell existing at the provided position This is the same as the Call createCell(CellType.BLANK,pos)
void	createNullCell() Create a Null cell at the end of this row.
IDARECell	getCell(int arg0) Get the IDARECell in the specified column from this Row.
IDARECell	getCell(int arg0, int arg1) Get the IDARECell in the specified column from this Row, using the specified policy to handle non existing or blank cells.
int	getCellIndex(BasicIDARECell cell) Get the position/index of a given Cell
short	getLastCellNum() Gets the index of the last cell contained in this row PLUS ONE.!
int	getRowNum() Get the position of this row in the enclosing IDARESheet;
Iterator<IDARECell>	iterator()

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

BasicIDARERow

public BasicIDARERow(BasicIDARESheet parent)

Simple constructor providing the parent sheet.

Parameters:

parent - The BasicIDARESheet containing this Row.

Method Detail

iterator

public Iterator<IDARECell> iterator()

Specified by:

iterator in interface Iterable<IDARECell>

cellIterator

public Iterator<IDARECell> cellIterator()

Description copied from interface: IDARERow

Obtain an Iterator over the IDARECells of this row.

Specified by:

cellIterator in interface IDARERow

Returns:

the iterator starting with the first cell.

getCell

public IDARECell getCell(int arg0)

Description copied from interface: IDARERow

Get the IDARECell in the specified column from this Row. This is the same as a call to getCell(arg0,IDARERow.RETURN_NULL_AND_BLANK)

Specified by:

getCell in interface IDARERow

Parameters:

arg0 - the column requested

Returns:

the IDARECell at the specified position, or null, if it does not exist

getCell

public IDARECell getCell(int arg0,
                         int arg1)

Description copied from interface: IDARERow

Get the IDARECell in the specified column from this Row, using the specified policy to handle non existing or blank cells.

Specified by:

getCell in interface IDARERow

Parameters:

arg0 - the column requested

arg1 - The row requested

Returns:

the IDARECell at the specified position (blank or nulls will be handled according to the provided policy.

getLastCellNum

public short getLastCellNum()

Description copied from interface: IDARERow

Gets the index of the last cell contained in this row PLUS ONE.!

Specified by:

getLastCellNum in interface IDARERow

Returns:

the last index of a non null cell in this row

getRowNum

public int getRowNum()

Description copied from interface: IDARERow

Get the position of this row in the enclosing IDARESheet;

Specified by:

getRowNum in interface IDARERow

Returns:

the position of this row in the enclosing IDARESheet

createNullCell

public void createNullCell()

Create a Null cell at the end of this row.

createCell

public BasicIDARECell createCell()

Create a Blank Cell at the end of this row. This is the same as createCell(getLastCellNum()-1)

Returns:

the created cell.

createCell

public BasicIDARECell createCell(IDARECell.CellType type)

Create a Cell with a specified type at the end of this row This is the same as a call to createCell(type,getLastCellNum()-1)

Parameters:

type - the type of the created cell

Returns:

the created cell

createCell

public BasicIDARECell createCell(int pos)

Create a blank cell at a specified position, overwriting any cell existing at the provided position This is the same as the Call createCell(CellType.BLANK,pos)

Parameters:

pos - the 0-based position at which to place the cell.

Returns:

the created cell

createCell

public BasicIDARECell createCell(IDARECell.CellType CellType,
                                 int pos)

Create a Cell of the specified type at the specified position. This extends the row accordingly.

Parameters:

CellType - The IDARECell.CellType of the created cell

pos - the 0-based position of the cell

Returns:

the created BasicIDARECell

getCellIndex

public int getCellIndex(BasicIDARECell cell)

Get the position/index of a given Cell

Parameters:

cell - the cell for which the index is requested

Returns:

the 0-based index of the cell.