Package org.apache.poi.ss.formula

Interface EvaluationSheet

@Internal
public interface EvaluationSheet

Abstracts a sheet for the purpose of formula evaluation.

Method Summary

Modifier and Type	Method	Description
void	clearAllCachedResultValues()	Propagated from EvaluationWorkbook.clearAllCachedResultValues() to clear locally cached data.
EvaluationCell	getCell(int rowIndex, int columnIndex)
int	getLastRowNum()
default boolean	isFiltered()
boolean	isHidden(int rowIndex, int columnIndex)
boolean	isRowHidden(int rowIndex)	Used by SUBTOTAL and similar functions that have options to ignore hidden rows
java.util.Iterator<EvaluationCell>	nonEmptyCellsIterator(int columnIndex)
java.util.Iterator<EvaluationCell>	nonEmptyCellsIterator(int rowStart, int rowEnd, int columnStart, int columnEnd)

Method Detail

getCell

EvaluationCell getCell(int rowIndex,
                       int columnIndex)

Returns:

null if there is no cell at the specified coordinates

nonEmptyCellsIterator

java.util.Iterator<EvaluationCell> nonEmptyCellsIterator(int rowStart,
                                                         int rowEnd,
                                                         int columnStart,
                                                         int columnEnd)

nonEmptyCellsIterator

java.util.Iterator<EvaluationCell> nonEmptyCellsIterator(int columnIndex)

clearAllCachedResultValues

void clearAllCachedResultValues()

Propagated from EvaluationWorkbook.clearAllCachedResultValues() to clear locally cached data.

Since:

POI 3.15 beta 3

See Also:

WorkbookEvaluator.clearAllCachedResultValues(), EvaluationWorkbook.clearAllCachedResultValues()

getLastRowNum

int getLastRowNum()

Returns:

last row index referenced on this sheet, for evaluation optimization

Since:

POI 4.0.0

isRowHidden

boolean isRowHidden(int rowIndex)

Used by SUBTOTAL and similar functions that have options to ignore hidden rows

Returns:

true if the row is hidden, false if not

Since:

POI 4.1.0

isHidden

boolean isHidden(int rowIndex,
                 int columnIndex)

isFiltered

default boolean isFiltered()