com.github.pjfanning.xlsx.impl

Class StreamingRow

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingRow

All Implemented Interfaces:

java.lang.Iterable<org.apache.poi.ss.usermodel.Cell>, org.apache.poi.ss.usermodel.Row

public class StreamingRow
extends java.lang.Object
implements org.apache.poi.ss.usermodel.Row

Nested Class Summary

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

org.apache.poi.ss.usermodel.Row.MissingCellPolicy

Constructor Summary

Constructors

Constructor and Description
StreamingRow(org.apache.poi.ss.usermodel.Sheet sheet, int rowIndex, boolean isHidden)

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<org.apache.poi.ss.usermodel.Cell>	cellIterator()
org.apache.poi.ss.usermodel.Cell	createCell(int column) Not supported
org.apache.poi.ss.usermodel.Cell	createCell(int i, org.apache.poi.ss.usermodel.CellType cellType) Not supported
org.apache.poi.ss.usermodel.Cell	getCell(int cellnum) Get the cell representing a given column (logical cell) 0-based.
org.apache.poi.ss.usermodel.Cell	getCell(int cellnum, org.apache.poi.ss.usermodel.Row.MissingCellPolicy policy)
java.util.Map<java.lang.Integer,org.apache.poi.ss.usermodel.Cell>	getCellMap()
short	getFirstCellNum()
short	getHeight() Not supported
float	getHeightInPoints() Not supported
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
org.apache.poi.ss.usermodel.CellStyle	getRowStyle() Not supported
org.apache.poi.ss.usermodel.Sheet	getSheet()
boolean	getZeroHeight() Get whether or not to display this row with 0 height
boolean	isFormatted() Not supported
java.util.Iterator<org.apache.poi.ss.usermodel.Cell>	iterator()
void	removeCell(org.apache.poi.ss.usermodel.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(org.apache.poi.ss.usermodel.CellStyle style) Update operations are not supported
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
java.util.Spliterator<org.apache.poi.ss.usermodel.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(org.apache.poi.ss.usermodel.Sheet sheet,
                    int rowIndex,
                    boolean isHidden)

Method Detail

getCellMap

public java.util.Map<java.lang.Integer,org.apache.poi.ss.usermodel.Cell> getCellMap()

getRowNum

public int getRowNum()

Get row number this row represents

Specified by:

getRowNum in interface org.apache.poi.ss.usermodel.Row

Returns:

the row number (0 based)

cellIterator

public java.util.Iterator<org.apache.poi.ss.usermodel.Cell> cellIterator()

Specified by:

cellIterator in interface org.apache.poi.ss.usermodel.Row

Returns:

Cell iterator of the physically defined cells for this row.

iterator

public java.util.Iterator<org.apache.poi.ss.usermodel.Cell> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.apache.poi.ss.usermodel.Cell>

Specified by:

iterator in interface org.apache.poi.ss.usermodel.Row

Returns:

Cell iterator of the physically defined cells for this row.

spliterator

public java.util.Spliterator<org.apache.poi.ss.usermodel.Cell> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<org.apache.poi.ss.usermodel.Cell>

Specified by:

spliterator in interface org.apache.poi.ss.usermodel.Row

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

Specified by:

getSheet in interface org.apache.poi.ss.usermodel.Row

getCell

public org.apache.poi.ss.usermodel.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 org.apache.poi.ss.usermodel.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 org.apache.poi.ss.usermodel.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 org.apache.poi.ss.usermodel.Row

Returns:

- zHeight height is zero or not.

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 org.apache.poi.ss.usermodel.Row

Returns:

int representing the number of defined cells in the row.

getFirstCellNum

public short getFirstCellNum()

Specified by:

getFirstCellNum in interface org.apache.poi.ss.usermodel.Row

getCell

public org.apache.poi.ss.usermodel.Cell getCell(int cellnum,
                                                org.apache.poi.ss.usermodel.Row.MissingCellPolicy policy)

Specified by:

getCell in interface org.apache.poi.ss.usermodel.Row

createCell

public org.apache.poi.ss.usermodel.Cell createCell(int column)

Not supported

Specified by:

createCell in interface org.apache.poi.ss.usermodel.Row

createCell

public org.apache.poi.ss.usermodel.Cell createCell(int i,
                                                   org.apache.poi.ss.usermodel.CellType cellType)

Not supported

Specified by:

createCell in interface org.apache.poi.ss.usermodel.Row

removeCell

public void removeCell(org.apache.poi.ss.usermodel.Cell cell)

Update operations are not supported

Specified by:

removeCell in interface org.apache.poi.ss.usermodel.Row

setRowNum

public void setRowNum(int rowNum)

Update operations are not supported

Specified by:

setRowNum in interface org.apache.poi.ss.usermodel.Row

setHeight

public void setHeight(short height)

Update operations are not supported

Specified by:

setHeight in interface org.apache.poi.ss.usermodel.Row

setZeroHeight

public void setZeroHeight(boolean zHeight)

Update operations are not supported

Specified by:

setZeroHeight in interface org.apache.poi.ss.usermodel.Row

setHeightInPoints

public void setHeightInPoints(float height)

Update operations are not supported

Specified by:

setHeightInPoints in interface org.apache.poi.ss.usermodel.Row

getHeight

public short getHeight()

Not supported

Specified by:

getHeight in interface org.apache.poi.ss.usermodel.Row

getHeightInPoints

public float getHeightInPoints()

Not supported

Specified by:

getHeightInPoints in interface org.apache.poi.ss.usermodel.Row

isFormatted

public boolean isFormatted()

Not supported

Specified by:

isFormatted in interface org.apache.poi.ss.usermodel.Row

getRowStyle

public org.apache.poi.ss.usermodel.CellStyle getRowStyle()

Not supported

Specified by:

getRowStyle in interface org.apache.poi.ss.usermodel.Row

setRowStyle

public void setRowStyle(org.apache.poi.ss.usermodel.CellStyle style)

Update operations are not supported

Specified by:

setRowStyle in interface org.apache.poi.ss.usermodel.Row

getOutlineLevel

public int getOutlineLevel()

Not supported

Specified by:

getOutlineLevel in interface org.apache.poi.ss.usermodel.Row

shiftCellsRight

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

Update operations are not supported

Specified by:

shiftCellsRight in interface org.apache.poi.ss.usermodel.Row

shiftCellsLeft

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

Update operations are not supported

Specified by:

shiftCellsLeft in interface org.apache.poi.ss.usermodel.Row