|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.ss.formula.WorkbookEvaluator
public final class WorkbookEvaluator
Evaluates formula cells.
For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure to callclearAllCachedResultValues()
if any workbook cells are changed between
calls to evaluate~ methods on this class.
Constructor Summary | |
---|---|
WorkbookEvaluator(EvaluationWorkbook workbook,
IStabilityClassifier stabilityClassifier,
UDFFinder udfFinder)
|
Method Summary | |
---|---|
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)
|
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 |
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 |
setIgnoreMissingWorkbooks(boolean ignore)
Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
udfFinder
- pass null
for default (AnalysisToolPak only)Method Detail |
---|
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 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 resolved
ignore
- whether to ignore missing references to external workbookspublic 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 register
java.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 register
java.lang.IllegalArgumentException
- if the function is unknown or already registered.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |