org.apache.poi.ss.formula
public final class OperationEvaluationContext extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static FreeRefFunction |
UDF |
Constructor and Description |
---|
OperationEvaluationContext(WorkbookEvaluator bookEvaluator,
EvaluationWorkbook workbook,
int sheetIndex,
int srcRowNum,
int srcColNum,
org.apache.poi.ss.formula.EvaluationTracker tracker) |
Modifier and Type | Method and Description |
---|---|
FreeRefFunction |
findUserDefinedFunction(java.lang.String functionName) |
ValueEval |
getArea3DEval(int firstRowIndex,
int firstColumnIndex,
int lastRowIndex,
int lastColumnIndex,
int extSheetIndex) |
ValueEval |
getAreaEval(int firstRowIndex,
int firstColumnIndex,
int lastRowIndex,
int lastColumnIndex) |
int |
getColumnIndex() |
ValueEval |
getDynamicReference(java.lang.String workbookName,
java.lang.String sheetName,
java.lang.String refStrPart1,
java.lang.String refStrPart2,
boolean isA1Style)
Resolves a cell or area reference dynamically.
|
ValueEval |
getRef3DEval(int rowIndex,
int columnIndex,
int extSheetIndex) |
ValueEval |
getRefEval(int rowIndex,
int columnIndex) |
org.apache.poi.ss.formula.SheetRefEvaluator |
getRefEvaluatorForCurrentSheet() |
int |
getRowIndex() |
EvaluationWorkbook |
getWorkbook() |
public static final FreeRefFunction UDF
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.apache.poi.ss.formula.EvaluationTracker tracker)
public EvaluationWorkbook getWorkbook()
public int getRowIndex()
public int getColumnIndex()
public org.apache.poi.ss.formula.SheetRefEvaluator getRefEvaluatorForCurrentSheet()
public ValueEval getDynamicReference(java.lang.String workbookName, java.lang.String sheetName, java.lang.String refStrPart1, java.lang.String refStrPart2, boolean isA1Style)
workbookName
- the name of the workbook containing the reference. If null
the current workbook is assumed. Note - to evaluate formulas which use multiple workbooks,
a CollaboratingWorkbooksEnvironment
must be set up.sheetName
- the name of the sheet containing the reference. May be null
(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
be null
.refStrPart2
- the second part of the area reference. For single cell references this
parameter must be null
isA1Style
- specifies the format for refStrPart1 and refStrPart2.
Pass true
for 'A1' style and false
for 'R1C1' style.
TODO - currently POI only supports 'A1' reference styleRefEval
or AreaEval
public FreeRefFunction findUserDefinedFunction(java.lang.String functionName)
public ValueEval getRefEval(int rowIndex, int columnIndex)
public ValueEval getRef3DEval(int rowIndex, int columnIndex, int extSheetIndex)
public ValueEval getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex)
public ValueEval getArea3DEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, int extSheetIndex)
Copyright 2014 The Apache Software Foundation or its licensors, as applicable.