com.github.pjfanning.xlsx.impl

Class StreamingRow

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingRow

All Implemented Interfaces:

Iterable<Cell>, Row

public class StreamingRow
extends Object
implements Row

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.Row

Row.MissingCellPolicy

Constructor Summary

Constructors

Constructor and Description
StreamingRow(Sheet sheet, int rowIndex, boolean isHidden)

Method Summary

Modifier and Type	Method and Description
Iterator<Cell>	cellIterator()
Cell	createCell(int column) Not supported
Cell	createCell(int i, CellType cellType) Not supported
Cell	getCell(int cellnum) Get the cell representing a given column (logical cell) 0-based.
Cell	getCell(int cellnum, Row.MissingCellPolicy policy)
Map<Integer,Cell>	getCellMap()
short	getFirstCellNum()
short	getHeight()
float	getHeightInPoints()
short	getLastCellNum() Gets the index of the last cell contained in this row PLUS ONE.
int	getOutlineLevel() Not supported
int	getPhysicalNumberOfCells() Gets the number of defined cells (NOT number of cells in the actual row!).
int	getRowNum() Get row number this row represents
CellStyle	getRowStyle()
Sheet	getSheet()
boolean	getZeroHeight() Get whether or not to display this row with 0 height
boolean	isFormatted()
Iterator<Cell>	iterator()
void	removeCell(Cell cell) Update operations are not supported
void	setHeight(short height) Update operations are not supported
void	setHeightInPoints(float height) Update operations are not supported
void	setRowNum(int rowNum) Update operations are not supported
void	setRowStyle(CellStyle style)
void	setZeroHeight(boolean zHeight) Update operations are not supported
void	shiftCellsLeft(int firstShiftColumnIndex, int lastShiftColumnIndex, int step) Update operations are not supported
void	shiftCellsRight(int firstShiftColumnIndex, int lastShiftColumnIndex, int step) Update operations are not supported
Spliterator<Cell>	spliterator()

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

Constructor Detail

StreamingRow

public StreamingRow(Sheet sheet,
                    int rowIndex,
                    boolean isHidden)

Method Detail

getCellMap

public Map<Integer,Cell> getCellMap()

getRowNum

public int getRowNum()

Get row number this row represents

Specified by:

getRowNum in interface Row

Returns:

the row number (0 based)

cellIterator

public Iterator<Cell> cellIterator()

Specified by:

cellIterator in interface Row

Returns:

Cell iterator of the physically defined cells for this row.

iterator

public Iterator<Cell> iterator()

Specified by:

iterator in interface Iterable<Cell>

Specified by:

iterator in interface Row

Returns:

Cell iterator of the physically defined cells for this row.

spliterator

public Spliterator<Cell> spliterator()

Specified by:

spliterator in interface Iterable<Cell>

Specified by:

spliterator in interface Row

getSheet

public Sheet getSheet()

Specified by:

getSheet in interface Row

getCell

public Cell getCell(int cellnum)

Get the cell representing a given column (logical cell) 0-based. If you ask for a cell that is not defined, you get a null.

Specified by:

getCell in interface Row

Parameters:

cellnum - 0 based column number

Returns:

Cell representing that column or null if undefined.

getLastCellNum

public short getLastCellNum()

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

Specified by:

getLastCellNum in interface Row

Returns:

short representing the last logical cell in the row PLUS ONE, or -1 if the row does not contain any cells.

getZeroHeight

public boolean getZeroHeight()

Get whether or not to display this row with 0 height

Specified by:

getZeroHeight in interface Row

Returns:

- zHeight height is zero or not.

getHeight

public short getHeight()

Specified by:

getHeight in interface Row

getHeightInPoints

public float getHeightInPoints()

Specified by:

getHeightInPoints in interface Row

getPhysicalNumberOfCells

public int getPhysicalNumberOfCells()

Gets the number of defined cells (NOT number of cells in the actual row!). That is to say if only columns 0,4,5 have values then there would be 3.

Specified by:

getPhysicalNumberOfCells in interface Row

Returns:

int representing the number of defined cells in the row.

getFirstCellNum

public short getFirstCellNum()

Specified by:

getFirstCellNum in interface Row

getCell

public Cell getCell(int cellnum,
                    Row.MissingCellPolicy policy)

Specified by:

getCell in interface Row

isFormatted

public boolean isFormatted()

Specified by:

isFormatted in interface Row

getRowStyle

public CellStyle getRowStyle()

Specified by:

getRowStyle in interface Row

setRowStyle

public void setRowStyle(CellStyle style)

Specified by:

setRowStyle in interface Row

createCell

public Cell createCell(int column)

Not supported

Specified by:

createCell in interface Row

createCell

public Cell createCell(int i,
                       CellType cellType)

Not supported

Specified by:

createCell in interface Row

removeCell

public void removeCell(Cell cell)

Update operations are not supported

Specified by:

removeCell in interface Row

setRowNum

public void setRowNum(int rowNum)

Update operations are not supported

Specified by:

setRowNum in interface Row

setHeight

public void setHeight(short height)

Update operations are not supported

Specified by:

setHeight in interface Row

setZeroHeight

public void setZeroHeight(boolean zHeight)

Update operations are not supported

Specified by:

setZeroHeight in interface Row

setHeightInPoints

public void setHeightInPoints(float height)

Update operations are not supported

Specified by:

setHeightInPoints in interface Row

getOutlineLevel

public int getOutlineLevel()

Not supported

Specified by:

getOutlineLevel in interface Row

shiftCellsRight

public void shiftCellsRight(int firstShiftColumnIndex,
                            int lastShiftColumnIndex,
                            int step)

Update operations are not supported

Specified by:

shiftCellsRight in interface Row

shiftCellsLeft

public void shiftCellsLeft(int firstShiftColumnIndex,
                           int lastShiftColumnIndex,
                           int step)

Update operations are not supported

Specified by:

shiftCellsLeft in interface Row