@Internal public final class WorkbookEvaluator extends java.lang.Object
clearAllCachedResultValues()
if any workbook cells are changed between
calls to evaluate~ methods on this class.Constructor and Description |
---|
WorkbookEvaluator(EvaluationWorkbook workbook,
IStabilityClassifier stabilityClassifier,
UDFFinder udfFinder) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
adjustRegionRelativeReference(Ptg[] ptgs,
CellReference target,
CellRangeAddressBase region)
Adjust formula relative references by the offset between the start of the given region and the given target cell.
|
void |
clearAllCachedResultValues()
Should be called whenever there are changes to input cells in the evaluated workbook.
|
static ValueEval |
dereferenceResult(ValueEval evaluationResult,
int srcRowNum,
int srcColNum)
Dereferences a single value from any AreaEval or RefEval evaluation
result.
|
ValueEval |
evaluate(EvaluationCell srcCell) |
ValueEval |
evaluate(java.lang.String formula,
CellReference ref)
Evaluate a formula outside a cell value, e.g.
|
ValueEval |
evaluate(java.lang.String formula,
CellReference target,
CellRangeAddressBase region)
Some expressions need to be evaluated in terms of an offset from the top left corner of a region,
such as some data validation and conditional format expressions, when those constraints apply
to contiguous cells.
|
ValueEval |
evaluateList(java.lang.String formula,
CellReference target,
CellRangeAddressBase region)
Some expressions need to be evaluated in terms of an offset from the top left corner of a region,
such as some data validation and conditional format expressions, when those constraints apply
to contiguous cells.
|
FreeRefFunction |
findUserDefinedFunction(java.lang.String functionName) |
static java.util.Collection<java.lang.String> |
getNotSupportedFunctionNames()
Return a collection of functions that POI does not support
|
static java.util.Collection<java.lang.String> |
getSupportedFunctionNames()
Return a collection of functions that POI can evaluate
|
boolean |
isDebugEvaluationOutputForNextEval() |
boolean |
isIgnoreMissingWorkbooks() |
void |
notifyDeleteCell(EvaluationCell cell)
Should be called to tell the cell value cache that the specified cell has just been
deleted.
|
void |
notifyUpdateCell(EvaluationCell cell)
Should be called to tell the cell value cache that the specified (value or formula) cell
has changed.
|
static void |
registerFunction(java.lang.String name,
FreeRefFunction func)
Register a ATP function in runtime.
|
static void |
registerFunction(java.lang.String name,
Function func)
Register a function in runtime.
|
void |
setDebugEvaluationOutputForNextEval(boolean value) |
void |
setIgnoreMissingWorkbooks(boolean ignore)
Whether to ignore missing references to external workbooks and
use cached formula results in the main workbook instead.
|
public WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
udfFinder
- pass null
for default (AnalysisToolPak only)public void clearAllCachedResultValues()
public void notifyUpdateCell(EvaluationCell cell)
public void notifyDeleteCell(EvaluationCell cell)
public ValueEval evaluate(EvaluationCell srcCell)
public static ValueEval dereferenceResult(ValueEval evaluationResult, int srcRowNum, int srcColNum)
NumberEval
, StringEval
, BoolEval
, or
ErrorEval
. Never null
. BlankEval
is
converted to NumberEval.ZERO
public FreeRefFunction findUserDefinedFunction(java.lang.String functionName)
public ValueEval evaluate(java.lang.String formula, CellReference ref)
formula
- to evaluateref
- defines the optional sheet and row/column base for the formula, if it is relativepublic ValueEval evaluate(java.lang.String formula, CellReference target, CellRangeAddressBase region)
Returns a single value e.g. a cell formula result or boolean value for conditional formatting.
formula
- The formula to evaluatetarget
- cell context for the operationregion
- containing the celljava.lang.IllegalArgumentException
- if target does not define a sheet name to evaluate the formula on.public ValueEval evaluateList(java.lang.String formula, CellReference target, CellRangeAddressBase region)
Returns a ValueEval that may be one or more values, such as the allowed values for a data validation constraint.
formula
- The formula to evaluatetarget
- cell context for the operationregion
- containing the celljava.lang.IllegalArgumentException
- if target does not define a sheet name to evaluate the formula on.protected boolean adjustRegionRelativeReference(Ptg[] ptgs, CellReference target, CellRangeAddressBase region)
formula ref + range top-left + current cell range offsetwhich simplifies to
formula ref + current cell ref
ptgs
- target
- cell within the region to use.region
- containing the cell, OR, for conditional format rules with multiple ranges, the region with the top-left-most celljava.lang.IndexOutOfBoundsException
- if the resulting shifted row/column indexes are over the document format limitsjava.lang.IllegalArgumentException
- if target is not within region.public void setIgnoreMissingWorkbooks(boolean ignore)
In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. With this method you can control how POI handles such missing references:
CollaboratingWorkbooksEnvironment.WorkbookNotFoundException
if an external reference cannot be resolvedignore
- whether to ignore missing references to external workbookspublic boolean isIgnoreMissingWorkbooks()
public static java.util.Collection<java.lang.String> getSupportedFunctionNames()
public static java.util.Collection<java.lang.String> getNotSupportedFunctionNames()
public static void registerFunction(java.lang.String name, FreeRefFunction func)
name
- the function namefunc
- the functoin to registerjava.lang.IllegalArgumentException
- if the function is unknown or already registered.public static void registerFunction(java.lang.String name, Function func)
name
- the function namefunc
- the functoin to registerjava.lang.IllegalArgumentException
- if the function is unknown or already registered.public void setDebugEvaluationOutputForNextEval(boolean value)
public boolean isDebugEvaluationOutputForNextEval()
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.