org.zkoss.poi.ss.formula

Class WorkbookEvaluator

java.lang.Object

org.zkoss.poi.ss.formula.WorkbookEvaluator

public final class WorkbookEvaluator
extends java.lang.Object

Evaluates formula cells.

For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure to call clearAllCachedResultValues() if any workbook cells are changed between calls to evaluate~ methods on this class.
For POI internal use only

Author:

Josh Micich, Thies Wellpott (debug output enhancements), Henri Chen (henrichen at zkoss dot org) - Sheet1:Sheet3!xxx 3d reference, dependency tracking

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkbookEvaluator.CacheManager

Constructor Summary

Constructors

Constructor and Description
WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder, WorkbookEvaluator.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
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, java.lang.Object ref)
ValueEval	evaluate(EvaluationCell srcCell, java.lang.Object ref, int[] offset)
ValueEval	evaluate(int sheetIndex, int rowIndex, int columnIndex, java.lang.String formula, boolean ignoreDereference, java.lang.Object ref, int[] offset)
ValueEval	evaluate(int sheetIndex, java.lang.String formula, boolean ignoreDereference, java.lang.Object ref)
ValueEval	evaluate(int sheetIndex, java.lang.String formula, boolean ignoreDereference, java.lang.Object ref, int[] offset) Deprecated.
ValueEval	evaluatePtgs(int sheetIndex, Ptg[] tokens, boolean ignoreDereference, java.lang.Object ref)
ValueEval	evaluatePtgs(int sheetIndex, Ptg[] tokens, boolean ignoreDereference, java.lang.Object ref, int[] offset)
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	setDebugEvaluationOutputForNextEval(boolean value)
void	setDependencyTracker(DependencyTracker tracker)
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

WorkbookEvaluator

public WorkbookEvaluator(EvaluationWorkbook workbook,
                         IStabilityClassifier stabilityClassifier,
                         UDFFinder udfFinder)

Parameters:

udfFinder - pass null for default (AnalysisToolPak only)

WorkbookEvaluator

public WorkbookEvaluator(EvaluationWorkbook workbook,
                         IStabilityClassifier stabilityClassifier,
                         UDFFinder udfFinder,
                         WorkbookEvaluator.CacheManager cacheManager)

Method Detail

setDependencyTracker

public void setDependencyTracker(DependencyTracker tracker)

clearAllCachedResultValues

public void clearAllCachedResultValues()

Should be called whenever there are changes to input cells in the evaluated workbook. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class

notifyUpdateCell

public void notifyUpdateCell(EvaluationCell cell)

Should be called to tell the cell value cache that the specified (value or formula) cell has changed.

notifyDeleteCell

public void notifyDeleteCell(EvaluationCell cell)

Should be called to tell the cell value cache that the specified cell has just been deleted.

evaluate

public ValueEval evaluate(EvaluationCell srcCell,
                          java.lang.Object ref)

evaluate

public ValueEval evaluate(EvaluationCell srcCell,
                          java.lang.Object ref,
                          int[] offset)

dereferenceResult

public static ValueEval dereferenceResult(ValueEval evaluationResult,
                                          int srcRowNum,
                                          int srcColNum)

Dereferences a single value from any AreaEval or RefEval evaluation result. If the supplied evaluationResult is just a plain value, it is returned as-is.

Returns:

a NumberEval, StringEval, BoolEval, or ErrorEval. Never null. BlankEval is converted to NumberEval.ZERO

findUserDefinedFunction

public FreeRefFunction findUserDefinedFunction(java.lang.String functionName)

setIgnoreMissingWorkbooks

public void setIgnoreMissingWorkbooks(boolean ignore)

Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead.

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:

• by default ignoreMissingWorkbooks=false and POI throws CollaboratingWorkbooksEnvironment.WorkbookNotFoundException if an external reference cannot be resolved
• if ignoreMissingWorkbooks=true then POI uses cached formula result that already exists in the main workbook

Parameters:

ignore - whether to ignore missing references to external workbooks

See Also:

Bug 52575 for details

getSupportedFunctionNames

public static java.util.Collection<java.lang.String> getSupportedFunctionNames()

Return a collection of functions that POI can evaluate

Returns:

names of functions supported by POI

getNotSupportedFunctionNames

public static java.util.Collection<java.lang.String> getNotSupportedFunctionNames()

Return a collection of functions that POI does not support

Returns:

names of functions NOT supported by POI

registerFunction

public static void registerFunction(java.lang.String name,
                                    FreeRefFunction func)

Register a ATP function in runtime.

Parameters:

name - the function name

func - the functoin to register

Throws:

java.lang.IllegalArgumentException - if the function is unknown or already registered.

Since:

3.8 beta6

registerFunction

public static void registerFunction(java.lang.String name,
                                    Function func)

Register a function in runtime.

Parameters:

name - the function name

func - the functoin to register

Throws:

java.lang.IllegalArgumentException - if the function is unknown or already registered.

Since:

3.8 beta6

evaluate

public ValueEval evaluate(int sheetIndex,
                          java.lang.String formula,
                          boolean ignoreDereference,
                          java.lang.Object ref)

evaluate

@Deprecated
public ValueEval evaluate(int sheetIndex,
                                       java.lang.String formula,
                                       boolean ignoreDereference,
                                       java.lang.Object ref,
                                       int[] offset)

Deprecated.

evaluate

public ValueEval evaluate(int sheetIndex,
                          int rowIndex,
                          int columnIndex,
                          java.lang.String formula,
                          boolean ignoreDereference,
                          java.lang.Object ref,
                          int[] offset)

setDebugEvaluationOutputForNextEval

public void setDebugEvaluationOutputForNextEval(boolean value)

evaluatePtgs

public ValueEval evaluatePtgs(int sheetIndex,
                              Ptg[] tokens,
                              boolean ignoreDereference,
                              java.lang.Object ref)

evaluatePtgs

public ValueEval evaluatePtgs(int sheetIndex,
                              Ptg[] tokens,
                              boolean ignoreDereference,
                              java.lang.Object ref,
                              int[] offset)