Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.OperationEvaluationContext

Modifier and Type	Field and Description
private final WorkbookEvaluator	_bookEvaluator
private final int	_columnIndex
private boolean	_isInArrayContext
private final boolean	_isSingleValue
private final int	_rowIndex
private final int	_sheetIndex
private final EvaluationTracker	_tracker
private final EvaluationWorkbook	_workbook
public static final FreeRefFunction	UDF

Access	Constructor and Description
public	OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, EvaluationTracker tracker)
public	OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, EvaluationTracker tracker, boolean isSingleValue)

Method Summary

Modifier and Type	Method and Description
public static CellReference	applyR1C1Reference(CellReference anchorReference, String relativeReference)
private static CellReference.NameType	classifyCellReference(String str, SpreadsheetVersion ssVersion)
private ValueEval	convertObjectEval(Object token)
pack-priv SheetRangeEvaluator	createExternSheetRefEvaluator(ExternSheetReferenceToken ptg)
pack-priv SheetRangeEvaluator	createExternSheetRefEvaluator(String firstSheetName, String lastSheetName, int externalWorkbookNumber)
pack-priv SheetRangeEvaluator	createExternSheetRefEvaluator(int externSheetIndex)
pack-priv SheetRangeEvaluator	createExternSheetRefEvaluator(EvaluationWorkbook.ExternalSheet externalSheet)
private SheetRefEvaluator	Returns: `null` if either workbook or sheet is not found createExternSheetRefEvaluator(String workbookName, String sheetName)
public FreeRefFunction	findUserDefinedFunction(String functionName)
public ValueEval	getArea3DEval(Area3DPtg aptg)
public ValueEval	getArea3DEval(Area3DPxg aptg)
public ValueEval	getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex)
public ValueEval	getAreaValueEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, Object[][] tokens)
public int	getColumnIndex()
public ValueEval	Returns: a `RefEval` or `AreaEval` getDynamicReference(String 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. workbookName, String 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. sheetName, String the single cell reference or first part of the area reference. Must not be `null`. refStrPart1, String the second part of the area reference. For single cell references this parameter must be `null` refStrPart2, boolean specifies the format for `refStrPart1` and `refStrPart2`. Pass `true` for 'A1' style and `false` for 'R1C1' style. isA1Style) Resolves a cell or area reference dynamically.
private ValueEval	getExternalNameXEval(EvaluationWorkbook.ExternalName externName, String workbookName)
private ValueEval	getLocalNameXEval(NameXPxg nameXPxg)
private ValueEval	getLocalNameXEval(NameXPtg nameXPtg)
public ValueEval	getNameXEval(NameXPtg nameXPtg)
public ValueEval	getNameXEval(NameXPxg nameXPxg)
private static CellReference.NameType	getR1C1CellType(String str)
public ValueEval	getRef3DEval(Ref3DPtg rptg)
public ValueEval	getRef3DEval(Ref3DPxg rptg)
public ValueEval	getRefEval(int rowIndex, int columnIndex)
public SheetRangeEvaluator	getRefEvaluatorForCurrentSheet()
public int	getRowIndex()
public int	getSheetIndex()
public EvaluationWorkbook	getWorkbook()
public boolean	isArraymode()
public boolean	Returns: flag indicating whether evaluation should "unwrap" the result to a single value based on the context row/column isSingleValue() default true
private static int	parseColRef(String refStrPart)
private static int	parseRowRef(String refStrPart)
public void	setArrayMode(boolean value)

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

_bookEvaluator	back to summary
private final WorkbookEvaluator _bookEvaluator

_columnIndex	back to summary
private final int _columnIndex

_isInArrayContext	back to summary
private boolean _isInArrayContext

_isSingleValue	back to summary
private final boolean _isSingleValue

_rowIndex	back to summary
private final int _rowIndex

_sheetIndex	back to summary
private final int _sheetIndex

_tracker	back to summary
private final EvaluationTracker _tracker

_workbook	back to summary
private final EvaluationWorkbook _workbook

UDF	back to summary
public static final FreeRefFunction UDF

OperationEvaluationContext	back to summary
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, EvaluationTracker tracker)

OperationEvaluationContext	back to summary
public OperationEvaluationContext(WorkbookEvaluator bookEvaluator, EvaluationWorkbook workbook, int sheetIndex, int srcRowNum, int srcColNum, EvaluationTracker tracker, boolean isSingleValue)

Method Detail

applyR1C1Reference	back to summary
public static CellReference applyR1C1Reference(CellReference anchorReference, String relativeReference)

classifyCellReference	back to summary
private static CellReference.NameType classifyCellReference(String str, SpreadsheetVersion ssVersion)

convertObjectEval	back to summary
private ValueEval convertObjectEval(Object token)

createExternSheetRefEvaluator	back to summary
pack-priv SheetRangeEvaluator createExternSheetRefEvaluator(ExternSheetReferenceToken ptg)

createExternSheetRefEvaluator	back to summary
pack-priv SheetRangeEvaluator createExternSheetRefEvaluator(String firstSheetName, String lastSheetName, int externalWorkbookNumber)

createExternSheetRefEvaluator	back to summary
pack-priv SheetRangeEvaluator createExternSheetRefEvaluator(int externSheetIndex)

createExternSheetRefEvaluator	back to summary
pack-priv SheetRangeEvaluator createExternSheetRefEvaluator(EvaluationWorkbook.ExternalSheet externalSheet)

createExternSheetRefEvaluator	back to summary
private SheetRefEvaluator createExternSheetRefEvaluator(String workbookName, String sheetName) Returns:SheetRefEvaluator `null` if either workbook or sheet is not found

findUserDefinedFunction	back to summary
public FreeRefFunction findUserDefinedFunction(String functionName)

getArea3DEval	back to summary
public ValueEval getArea3DEval(Area3DPtg aptg)

getArea3DEval	back to summary
public ValueEval getArea3DEval(Area3DPxg aptg)

getAreaEval	back to summary
public ValueEval getAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex)

getAreaValueEval	back to summary
public ValueEval getAreaValueEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, Object[][] tokens)

getColumnIndex	back to summary
public int getColumnIndex()

getDynamicReference back to summary

getDynamicReference	back to summary
public ValueEval getDynamicReference(String workbookName, String sheetName, String refStrPart1, String refStrPart2, boolean isA1Style) Resolves a cell or area reference dynamically. Parameters workbookName:String 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:String 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:String the single cell reference or first part of the area reference. Must not be `null`. refStrPart2:String the second part of the area reference. For single cell references this parameter must be `null` isA1Style:boolean specifies the format for `refStrPart1` and `refStrPart2`. Pass `true` for 'A1' style and `false` for 'R1C1' style. Returns:ValueEval a `RefEval` or `AreaEval` Exceptions IllegalStateException: If invalid parameters are provided

public ValueEval getDynamicReference(String workbookName, String sheetName, String refStrPart1, String refStrPart2, boolean isA1Style)

Resolves a cell or area reference dynamically.

Parameters

workbookName:String: 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:String: 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:String: the single cell reference or first part of the area reference. Must not be null.
refStrPart2:String: the second part of the area reference. For single cell references this parameter must be null
isA1Style:boolean: specifies the format for refStrPart1 and refStrPart2. Pass true for 'A1' style and false for 'R1C1' style.

Returns:ValueEval

a RefEval or AreaEval

Exceptions

IllegalStateException:: If invalid parameters are provided

getExternalNameXEval	back to summary
private ValueEval getExternalNameXEval(EvaluationWorkbook.ExternalName externName, String workbookName)

getLocalNameXEval	back to summary
private ValueEval getLocalNameXEval(NameXPxg nameXPxg)

getLocalNameXEval	back to summary
private ValueEval getLocalNameXEval(NameXPtg nameXPtg)

getNameXEval	back to summary
public ValueEval getNameXEval(NameXPtg nameXPtg)

getNameXEval	back to summary
public ValueEval getNameXEval(NameXPxg nameXPxg)

getR1C1CellType	back to summary
private static CellReference.NameType getR1C1CellType(String str)

getRef3DEval	back to summary
public ValueEval getRef3DEval(Ref3DPtg rptg)

getRef3DEval	back to summary
public ValueEval getRef3DEval(Ref3DPxg rptg)

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

getRefEvaluatorForCurrentSheet	back to summary
public SheetRangeEvaluator getRefEvaluatorForCurrentSheet()

getRowIndex	back to summary
public int getRowIndex()

getSheetIndex	back to summary
public int getSheetIndex()

getWorkbook	back to summary
public EvaluationWorkbook getWorkbook()

isArraymode	back to summary
public boolean isArraymode()

isSingleValue	back to summary
public boolean isSingleValue() default true Returns:boolean flag indicating whether evaluation should "unwrap" the result to a single value based on the context row/column

isSingleValue

back to summary

public boolean isSingleValue()

default true

Returns:boolean: flag indicating whether evaluation should "unwrap" the result to a single value based on the context row/column

parseColRef	back to summary
private static int parseColRef(String refStrPart)

parseRowRef	back to summary
private static int parseRowRef(String refStrPart)

setArrayMode	back to summary
public void setArrayMode(boolean value)

public final Class OperationEvaluationContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail