Top Description Fields Constructors Methods

org.apache.poi.ss.formula

pack-priv final Class SheetRefEvaluator

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.formula.SheetRefEvaluator

Imports

org.apache.poi.ss.formula.eval.ValueEval, org.apache.poi.ss.formula.ptg.FuncVarPtg, .Ptg, org.apache.poi.ss.usermodel.CellType

Evaluator for cells within a specific Sheet

Field Summary

Modifier and Type	Field and Description
private final WorkbookEvaluator	_bookEvaluator
private EvaluationSheet	_sheet
private final int	_sheetIndex
private final EvaluationTracker	_tracker

Constructor Summary

Access	Constructor and Description
public	SheetRefEvaluator(WorkbookEvaluator bookEvaluator, EvaluationTracker tracker, int sheetIndex)

Method Summary

Modifier and Type	Method and Description
public ValueEval	getEvalForCell(int rowIndex, int columnIndex)
public int	Returns: The last used row in this sheet getLastRowNum()
public int	Returns: The maximum row number that is possible for the current Spreadsheet version, see `org.apache.poi.ss.SpreadsheetVersion#getLastRowIndex()` getMaxRowNum()
private EvaluationSheet	getSheet()
public String	getSheetName()
public boolean	Returns: true if the row is hidden isRowHidden(int The 0-based row-index to check rowIndex) Used by functions that calculate differently depending on row visibility, like some variations of SUBTOTAL()
public boolean	Returns: whether cell at rowIndex and columnIndex is a subtotal isSubTotal(int The 0-based row-index to check rowIndex, int The 0-based column-index to check columnIndex)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_bookEvaluator	back to summary
private final WorkbookEvaluator _bookEvaluator

_sheet	back to summary
private EvaluationSheet _sheet

_sheetIndex	back to summary
private final int _sheetIndex

_tracker	back to summary
private final EvaluationTracker _tracker

Constructor Detail

SheetRefEvaluator	back to summary
public SheetRefEvaluator(WorkbookEvaluator bookEvaluator, EvaluationTracker tracker, int sheetIndex)

Method Detail

getEvalForCell	back to summary
public ValueEval getEvalForCell(int rowIndex, int columnIndex)

getLastRowNum	back to summary
public int getLastRowNum() Returns:int The last used row in this sheet

getMaxRowNum	back to summary
public int getMaxRowNum() Returns:int The maximum row number that is possible for the current Spreadsheet version, see `org.apache.poi.ss.SpreadsheetVersion#getLastRowIndex()`

getSheet	back to summary
private EvaluationSheet getSheet()

getSheetName	back to summary
public String getSheetName()

isRowHidden back to summary

public boolean isRowHidden(int rowIndex)

Used by functions that calculate differently depending on row visibility, like some variations of SUBTOTAL()

Parameters

rowIndex:int: The 0-based row-index to check

Returns:boolean

true if the row is hidden

See Also

org.apache.poi.ss.formula.functions.Subtotal

isSubTotal	back to summary
public boolean isSubTotal(int rowIndex, int columnIndex) Parameters rowIndex:int The 0-based row-index to check columnIndex:int The 0-based column-index to check Returns:boolean whether cell at rowIndex and columnIndex is a subtotal See Also `org.apache.poi.ss.formula.functions.Subtotal`