Package org.apache.poi.ss.formula
Class OperationEvaluationContext
java.lang.Object
org.apache.poi.ss.formula.OperationEvaluationContext
Contains all the contextual information required to evaluate an operation
within a formula
For POI internal use only
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionOperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.apache.poi.ss.formula.EvaluationTracker tracker) OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.apache.poi.ss.formula.EvaluationTracker tracker, boolean isSingleValue) -
Method Summary
Modifier and TypeMethodDescriptionfindUserDefinedFunction(String functionName) getArea3DEval(Area3DPtg aptg) getArea3DEval(Area3DPxg aptg) getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex) getAreaValueEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, Object[][] tokens) intgetDynamicReference(String workbookName, String sheetName, String refStrPart1, String refStrPart2, boolean isA1Style) Resolves a cell or area reference dynamically.getNameXEval(NameXPtg nameXPtg) getNameXEval(NameXPxg nameXPxg) getRef3DEval(Ref3DPtg rptg) getRef3DEval(Ref3DPxg rptg) getRefEval(int rowIndex, int columnIndex) org.apache.poi.ss.formula.SheetRangeEvaluatorintintbooleanbooleandefault truevoidsetArrayMode(boolean value)
-
Field Details
-
UDF
-
-
Constructor Details
-
OperationEvaluationContext
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.apache.poi.ss.formula.EvaluationTracker tracker) -
OperationEvaluationContext
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.apache.poi.ss.formula.EvaluationTracker tracker, boolean isSingleValue)
-
-
Method Details
-
isArraymode
public boolean isArraymode() -
setArrayMode
public void setArrayMode(boolean value) -
getWorkbook
-
getRowIndex
public int getRowIndex() -
getColumnIndex
public int getColumnIndex() -
getRefEvaluatorForCurrentSheet
public org.apache.poi.ss.formula.SheetRangeEvaluator getRefEvaluatorForCurrentSheet() -
getDynamicReference
public ValueEval getDynamicReference(String workbookName, String sheetName, String refStrPart1, String refStrPart2, boolean isA1Style) Resolves a cell or area reference dynamically.- Parameters:
workbookName- the name of the workbook containing the reference. Ifnullthe current workbook is assumed. Note - to evaluate formulas which use multiple workbooks, aCollaboratingWorkbooksEnvironmentmust be set up.sheetName- the name of the sheet containing the reference. May benull(when workbookName is also null) in which case the current workbook and sheet is assumed.refStrPart1- the single cell reference or first part of the area reference. Must not benull.refStrPart2- the second part of the area reference. For single cell references this parameter must benullisA1Style- specifies the format for refStrPart1 and refStrPart2. Passtruefor 'A1' style andfalsefor 'R1C1' style. TODO - currently POI only supports 'A1' reference style- Returns:
- a
RefEvalorAreaEval
-
findUserDefinedFunction
-
getRefEval
-
getRef3DEval
-
getRef3DEval
-
getAreaEval
public ValueEval getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex) -
getArea3DEval
-
getArea3DEval
-
getAreaValueEval
-
getNameXEval
-
getNameXEval
-
getSheetIndex
public int getSheetIndex() -
isSingleValue
public boolean isSingleValue()default true- Returns:
- flag indicating whether evaluation should "unwrap" the result to a single value based on the context row/column
-