org.zkoss.poi.ss.formula

Class OperationEvaluationContext

java.lang.Object

org.zkoss.poi.ss.formula.OperationEvaluationContext

public final class OperationEvaluationContext
extends java.lang.Object

Contains all the contextual information required to evaluate an operation within a formula For POI internal use only

Author:

Josh Micich, Henri Chen (henrichen at zkoss dot org) - Sheet1:Sheet3!xxx 3d reference

Field Summary

Fields

Modifier and Type	Field and Description
static FreeRefFunction	UDF

Constructor Summary

Constructors

Constructor and Description
OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.zkoss.poi.ss.formula.EvaluationTracker tracker, DependencyTracker dependencyTracker, java.lang.Object ref) Deprecated.
OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, org.zkoss.poi.ss.formula.EvaluationTracker tracker, DependencyTracker dependencyTracker, java.lang.Object ref, int[] offset)

Method Summary

Modifier and Type	Method and Description
FreeRefFunction	findUserDefinedFunction(java.lang.String functionName)
ValueEval	getArea3DEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, boolean row1Rel, boolean col1Rel, boolean row2Rel, boolean col2Rel, int extSheetIndex)
ValueEval	getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, boolean row1Rel, boolean col1Rel, boolean row2Rel, boolean col2Rel)
ValueEval	getArrayEval(ArrayPtg ptg)
int	getColumnIndex()
java.lang.Object	getDependent()
ValueEval	getDynamicReference(java.lang.String workbookName, java.lang.String sheetName, java.lang.String lastSheetName, java.lang.String refStrPart1, java.lang.String refStrPart2, boolean isA1Style) Resolves a cell or area reference dynamically.
EvaluationName	getName(java.lang.String name, int contextSheetIndex)
ValueEval	getNameXEval(NameXPtg nameXPtg)
int	getPtgIndex()
ValueEval	getRef3DEval(int rowIndex, int columnIndex, boolean rowRel, boolean colRel, int extSheetIndex)
ValueEval	getRefEval(int rowIndex, int columnIndex, boolean rowRel, boolean colRel)
SheetRefEvaluator	getRefEvaluatorForCurrentSheet()
int	getRowIndex()
java.lang.String	getSheetName()
EvaluationWorkbook	getWorkbook()
WorkbookEvaluator	getWorkbookEvaluator()
void	setPtgIndex(int index)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UDF

public static final FreeRefFunction UDF

Constructor Detail

OperationEvaluationContext

@Deprecated
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator,
                                               EvaluationWorkbook workbook,
                                               int sheetIndex,
                                               int srcRowNum,
                                               int srcColNum,
                                               org.zkoss.poi.ss.formula.EvaluationTracker tracker,
                                               DependencyTracker dependencyTracker,
                                               java.lang.Object ref)

Deprecated.

OperationEvaluationContext

public OperationEvaluationContext(WorkbookEvaluator bookEvaluator,
                                  EvaluationWorkbook workbook,
                                  int sheetIndex,
                                  int srcRowNum,
                                  int srcColNum,
                                  org.zkoss.poi.ss.formula.EvaluationTracker tracker,
                                  DependencyTracker dependencyTracker,
                                  java.lang.Object ref,
                                  int[] offset)

Method Detail

getWorkbook

public EvaluationWorkbook getWorkbook()

getRowIndex

public int getRowIndex()

getColumnIndex

public int getColumnIndex()

getSheetName

public java.lang.String getSheetName()

getRefEvaluatorForCurrentSheet

public SheetRefEvaluator getRefEvaluatorForCurrentSheet()

getDynamicReference

public ValueEval getDynamicReference(java.lang.String workbookName,
                                     java.lang.String sheetName,
                                     java.lang.String lastSheetName,
                                     java.lang.String refStrPart1,
                                     java.lang.String refStrPart2,
                                     boolean isA1Style)

Resolves a cell or area reference dynamically.

Parameters:

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 style

Returns:

a RefEval or AreaEval

findUserDefinedFunction

public FreeRefFunction findUserDefinedFunction(java.lang.String functionName)

getRefEval

public ValueEval getRefEval(int rowIndex,
                            int columnIndex,
                            boolean rowRel,
                            boolean colRel)

getRef3DEval

public ValueEval getRef3DEval(int rowIndex,
                              int columnIndex,
                              boolean rowRel,
                              boolean colRel,
                              int extSheetIndex)

getAreaEval

public ValueEval getAreaEval(int firstRowIndex,
                             int firstColumnIndex,
                             int lastRowIndex,
                             int lastColumnIndex,
                             boolean row1Rel,
                             boolean col1Rel,
                             boolean row2Rel,
                             boolean col2Rel)

getWorkbookEvaluator

public WorkbookEvaluator getWorkbookEvaluator()

getArea3DEval

public ValueEval getArea3DEval(int firstRowIndex,
                               int firstColumnIndex,
                               int lastRowIndex,
                               int lastColumnIndex,
                               boolean row1Rel,
                               boolean col1Rel,
                               boolean row2Rel,
                               boolean col2Rel,
                               int extSheetIndex)

getNameXEval

public ValueEval getNameXEval(NameXPtg nameXPtg)

getPtgIndex

public int getPtgIndex()

setPtgIndex

public void setPtgIndex(int index)

getName

public EvaluationName getName(java.lang.String name,
                              int contextSheetIndex)

getDependent

public java.lang.Object getDependent()

getArrayEval

public ValueEval getArrayEval(ArrayPtg ptg)