io.github.antoniovizuete.pojospreadsheet.core

Class RowImpl

java.lang.Object

io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet<Cell>

io.github.antoniovizuete.pojospreadsheet.core.RowImpl

All Implemented Interfaces:

Row, IntegerIndex, IntegerSet<Cell>

public class RowImpl
extends AbstractIntegerSet<Cell>
implements IntegerIndex, Row

Prototype class that represents a POI Row.

Row class is a child of SheetImpl

Has a collection of CellImpl.

Since:

0.1

Author:

Antonio Vizuete

Field Summary

Fields inherited from class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

set

Constructor Summary

Constructors

Constructor and Description
RowImpl(Sheet sheet, Integer index)

Method Summary

Modifier and Type	Method and Description
Cell	cell() Returns new CellImpl instance.
Cell	cell(Integer index) Returns the CellImpl located into indicated index column.
Cell	cell(String column) Returns the CellImpl located into indicated column.
Set<Cell>	cells() Cells set.
Cell	createItem(Integer index) Internal purpose method.
boolean	equals(Object o)
Integer	getIndex() Gets index.
int	hashCode()
Row	merge(Cell cell, int numCells) Merges the indicated cells.
Row	merge(Integer index, int numCells) Merges the indicated cells.
Row	merge(String address, int numCells) Merges the indicated cells.
Row	nextRow() Returns the next sibling Row.
Sheet	parentSheet() Returns the SheetImpl where the Cell is located.
Row	prevRow() Returns the previous sibling Row.

Methods inherited from class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

add, add, get, getMaxIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

RowImpl

public RowImpl(Sheet sheet,
               Integer index)

Method Detail

cells

public Set<Cell> cells()

Description copied from interface: Row

Cells set.

Specified by:

cells in interface Row

Returns:

the set

createItem

public Cell createItem(Integer index)

Internal purpose method.

Returns a new instance of a CellImpl placed into indicated column (index).

Specified by:

createItem in interface IntegerSet<Cell>

Parameters:

index - of the column where the new CellImpl will be placed.

Returns:

a new instance of CellImpl.

parentSheet

public Sheet parentSheet()

Returns the SheetImpl where the Cell is located.

Specified by:

parentSheet in interface Row

Returns:

the SheetImpl where the Cell is located.

nextRow

public Row nextRow()

Returns the next sibling Row.

Specified by:

nextRow in interface Row

Returns:

the next sibling Row.

prevRow

public Row prevRow()

Returns the previous sibling Row.

Specified by:

prevRow in interface Row

Returns:

the previous sibling Row.

Throws:

IllegalStateException - (optional) if you try to get the previous Row when you are located at the first Row of the SheetImpl.

merge

public Row merge(String address,
                 int numCells)

Merges the indicated cells.

Specified by:

merge in interface Row

Parameters:

address - of the first cell.

numCells - number of cells to be merged (to the right)

Returns:

the current instance.

merge

public Row merge(Integer index,
                 int numCells)

Merges the indicated cells.

Specified by:

merge in interface Row

Parameters:

index - column of the first cell.

numCells - number of cells to be merged (to the right)

Returns:

the current instance.

merge

public Row merge(Cell cell,
                 int numCells)

Merges the indicated cells.

Specified by:

merge in interface Row

Parameters:

cell - instance (CellImpl).

numCells - number of cells to be merged (to the right)

Returns:

the current instance.

cell

public Cell cell()

Returns new CellImpl instance.

Specified by:

cell in interface Row

Returns:

new CellImpl instance.

cell

public Cell cell(Integer index)

Returns the CellImpl located into indicated index column.

If not exist the referenced cell, the method returns to a new cell instance placed there.

Specified by:

cell in interface Row

Parameters:

index - column of cell.

Returns:

CellImpl

cell

public Cell cell(String column)

Returns the CellImpl located into indicated column.

If not exist the referenced cell, the method returns to a new cell instance placed there.

Specified by:

cell in interface Row

Parameters:

column - name.

Returns:

CellImpl

getIndex

public Integer getIndex()

Description copied from interface: IntegerIndex

Gets index.

Specified by:

getIndex in interface IntegerIndex

Returns:

the index

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object