org.zkoss.zss.model.impl.sys.formula

Class FormulaEngineImpl

java.lang.Object

org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl

All Implemented Interfaces:

Serializable, FormulaEngine

public class FormulaEngineImpl
extends Object
implements FormulaEngine, Serializable

A formula engine implemented by ZPOI

Author:

Pao

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FormulaEngineImpl.EvalContext
protected static class	FormulaEngineImpl.EvaluationResultImpl
protected static interface	FormulaEngineImpl.FormulaAdjuster
protected static class	FormulaEngineImpl.FormulaExpressionImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_EVALUATORS
protected static org.zkoss.poi.ss.formula.IStabilityClassifier	noCacheClassifier

Fields inherited from interface org.zkoss.zss.model.sys.formula.FormulaEngine

KEY_EXTERNAL_BOOK_NAMES, KEY_SHEET_INDEXES

Constructor Summary

Constructors

Constructor and Description
FormulaEngineImpl()

Method Summary

Modifier and Type	Method and Description
void	clearCache(FormulaClearContext context)
static EvaluationResult	convertToEvaluationResult(org.zkoss.poi.ss.formula.eval.ValueEval value)
EvaluationResult	evaluate(FormulaExpression expr, FormulaEvaluationContext context)
protected EvaluationResult	evaluateFormula(FormulaExpression expr, FormulaEvaluationContext context, EvalBook evalBook, org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator)
protected org.zkoss.poi.ss.formula.eval.ValueEval	evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator, int sheetIndex, FormulaExpression expr, boolean ignoreDereference, Ref dependent) Deprecated.
protected org.zkoss.poi.ss.formula.eval.ValueEval	evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator, int sheetIndex, FormulaExpression expr, boolean ignoreDereference, Ref dependent, int[] offset) Deprecated.
protected org.zkoss.poi.ss.formula.eval.ValueEval	evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator, int sheetIndex, int rowIndex, int columnIndex, FormulaExpression expr, boolean ignoreDereference, Ref dependent, int[] offset)
FormulaExpression	extend(String formula, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
FormulaExpression	extendPtgs(FormulaExpression fe, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
protected FormulaEngineImpl.FormulaAdjuster	getMoveAdjuster(SheetRegion region, int rowOffset, int columnOffset)
protected FormulaEngineImpl.FormulaAdjuster	getRenameNameAdjuster(int sheetIndex, String oldName, String newName)
protected FormulaEngineImpl.FormulaAdjuster	getRenameSheetAdjuster(SBook targetBook, String oldSheetName, String newSheetName)
protected FormulaEngineImpl.FormulaAdjuster	getReorderSheetAdjuster(SBook targetBook, int oldIndex, int newIndex)
protected static org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl.ResultValueEval	getResolvedValue(org.zkoss.poi.ss.formula.eval.ValueEval value)
protected FormulaEngineImpl.FormulaAdjuster	getShiftAdjuster(int rowOffset, int columnOffset)
protected FormulaEngineImpl.FormulaAdjuster	getTransposeAdjuster(int rowOrigin, int columnOrigin)
protected Object	getXelContext()
FormulaExpression	move(String formula, SheetRegion region, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula that care on sheet and region.
FormulaExpression	movePtgs(FormulaExpression fe, SheetRegion region, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula that care on sheet and region.
FormulaExpression	parse(String formula, FormulaParseContext context)
protected org.zkoss.poi.ss.formula.ptg.Ptg[]	parse(String formula, org.zkoss.poi.ss.formula.FormulaParsingWorkbook book, int sheetIndex, FormulaParseContext context)
FormulaExpression	renameColumnNameTablePtgs(FormulaExpression fexpr, STable table, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameName(String formula, SBook targetBook, int sheetIndex, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameName(String formula, SBook targetBook, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameNamePtgs(FormulaExpression fe, SBook targetBook, int sheetIndex, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameSheet(String formula, SBook targetBook, String oldSheetName, String newSheetName, FormulaParseContext context)
FormulaExpression	renameSheetPtgs(FormulaExpression fe, SBook targetBook, String oldSheetName, String newSheetName, FormulaParseContext context)
FormulaExpression	renameTableNameTablePtgs(FormulaExpression fexpr, SBook book, String oldName, String newName, FormulaParseContext context)
protected String	renderFormula(ParsingBook parsingBook, String formula, org.zkoss.poi.ss.formula.ptg.Ptg[] tokens, boolean always)
FormulaExpression	reorderSheetPtgs(FormulaExpression fexpr, SBook targetBook, int oldIndex, int newIndex, FormulaParseContext context)
protected void	setXelContext(Object ctx)
FormulaExpression	shift(String formula, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula base on the offset
FormulaExpression	shiftPtgs(FormulaExpression fe, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula base on the offset
FormulaExpression	shrink(String formula, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
FormulaExpression	shrinkPtgs(FormulaExpression fe, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
protected Ref	toDependRef(FormulaParseContext ctx, ParsingBook parsingBook, org.zkoss.poi.ss.formula.ptg.Ptg ptg, int ptgIndex)
FormulaExpression	transpose(String formula, int rowOrigin, int columnOrigin, FormulaParseContext context) Transpose the formula base one the origin
FormulaExpression	transposePtgs(FormulaExpression fe, int rowOrigin, int columnOrigin, FormulaParseContext context) Transpose the formula base one the origin
void	updateDependencyTable(FormulaExpression fexpr, FormulaParseContext context)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_EVALUATORS

public static final String KEY_EVALUATORS

See Also:

Constant Field Values

noCacheClassifier

protected static final org.zkoss.poi.ss.formula.IStabilityClassifier noCacheClassifier

Constructor Detail

FormulaEngineImpl

public FormulaEngineImpl()

Method Detail

parse

public FormulaExpression parse(String formula,
                               FormulaParseContext context)

Specified by:

parse in interface FormulaEngine

parse

protected org.zkoss.poi.ss.formula.ptg.Ptg[] parse(String formula,
                                                   org.zkoss.poi.ss.formula.FormulaParsingWorkbook book,
                                                   int sheetIndex,
                                                   FormulaParseContext context)

renderFormula

protected String renderFormula(ParsingBook parsingBook,
                               String formula,
                               org.zkoss.poi.ss.formula.ptg.Ptg[] tokens,
                               boolean always)

toDependRef

protected Ref toDependRef(FormulaParseContext ctx,
                          ParsingBook parsingBook,
                          org.zkoss.poi.ss.formula.ptg.Ptg ptg,
                          int ptgIndex)

evaluate

public EvaluationResult evaluate(FormulaExpression expr,
                                 FormulaEvaluationContext context)

Specified by:

evaluate in interface FormulaEngine

evaluateFormula

protected EvaluationResult evaluateFormula(FormulaExpression expr,
                                           FormulaEvaluationContext context,
                                           EvalBook evalBook,
                                           org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator)
                                    throws org.zkoss.poi.ss.formula.FormulaParseException,
                                           Exception

Throws:

org.zkoss.poi.ss.formula.FormulaParseException

Exception

convertToEvaluationResult

public static EvaluationResult convertToEvaluationResult(org.zkoss.poi.ss.formula.eval.ValueEval value)
                                                  throws org.zkoss.poi.ss.formula.eval.EvaluationException

Throws:

org.zkoss.poi.ss.formula.eval.EvaluationException

getResolvedValue

protected static org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl.ResultValueEval getResolvedValue(org.zkoss.poi.ss.formula.eval.ValueEval value)
                                                                                                  throws org.zkoss.poi.ss.formula.eval.EvaluationException

Throws:

org.zkoss.poi.ss.formula.eval.EvaluationException

getXelContext

protected Object getXelContext()

setXelContext

protected void setXelContext(Object ctx)

clearCache

public void clearCache(FormulaClearContext context)

Specified by:

clearCache in interface FormulaEngine

move

public FormulaExpression move(String formula,
                              SheetRegion region,
                              int rowOffset,
                              int columnOffset,
                              FormulaParseContext context)

Description copied from interface: FormulaEngine

Shift the formula that care on sheet and region.

Specified by:

move in interface FormulaEngine

Returns:

getMoveAdjuster

protected FormulaEngineImpl.FormulaAdjuster getMoveAdjuster(SheetRegion region,
                                                            int rowOffset,
                                                            int columnOffset)

shrink

public FormulaExpression shrink(String formula,
                                SheetRegion srcRegion,
                                boolean horizontal,
                                FormulaParseContext context)

Specified by:

shrink in interface FormulaEngine

extend

public FormulaExpression extend(String formula,
                                SheetRegion srcRegion,
                                boolean horizontal,
                                FormulaParseContext context)

Specified by:

extend in interface FormulaEngine

shift

public FormulaExpression shift(String formula,
                               int rowOffset,
                               int columnOffset,
                               FormulaParseContext context)

Description copied from interface: FormulaEngine

Shift the formula base on the offset

Specified by:

shift in interface FormulaEngine

Returns:

getShiftAdjuster

protected FormulaEngineImpl.FormulaAdjuster getShiftAdjuster(int rowOffset,
                                                             int columnOffset)

transpose

public FormulaExpression transpose(String formula,
                                   int rowOrigin,
                                   int columnOrigin,
                                   FormulaParseContext context)

Description copied from interface: FormulaEngine

Transpose the formula base one the origin

Specified by:

transpose in interface FormulaEngine

Returns:

getTransposeAdjuster

protected FormulaEngineImpl.FormulaAdjuster getTransposeAdjuster(int rowOrigin,
                                                                 int columnOrigin)

renameSheet

public FormulaExpression renameSheet(String formula,
                                     SBook targetBook,
                                     String oldSheetName,
                                     String newSheetName,
                                     FormulaParseContext context)

Specified by:

renameSheet in interface FormulaEngine

getRenameSheetAdjuster

protected FormulaEngineImpl.FormulaAdjuster getRenameSheetAdjuster(SBook targetBook,
                                                                   String oldSheetName,
                                                                   String newSheetName)

renameName

public FormulaExpression renameName(String formula,
                                    SBook targetBook,
                                    String oldName,
                                    String newName,
                                    FormulaParseContext context)

Specified by:

renameName in interface FormulaEngine

renameName

public FormulaExpression renameName(String formula,
                                    SBook targetBook,
                                    int sheetIndex,
                                    String oldName,
                                    String newName,
                                    FormulaParseContext context)

Specified by:

renameName in interface FormulaEngine

Returns:

getRenameNameAdjuster

protected FormulaEngineImpl.FormulaAdjuster getRenameNameAdjuster(int sheetIndex,
                                                                  String oldName,
                                                                  String newName)

movePtgs

public FormulaExpression movePtgs(FormulaExpression fe,
                                  SheetRegion region,
                                  int rowOffset,
                                  int columnOffset,
                                  FormulaParseContext context)

Description copied from interface: FormulaEngine

Shift the formula that care on sheet and region.

Specified by:

movePtgs in interface FormulaEngine

Returns:

shrinkPtgs

public FormulaExpression shrinkPtgs(FormulaExpression fe,
                                    SheetRegion srcRegion,
                                    boolean horizontal,
                                    FormulaParseContext context)

Specified by:

shrinkPtgs in interface FormulaEngine

Returns:

extendPtgs

public FormulaExpression extendPtgs(FormulaExpression fe,
                                    SheetRegion srcRegion,
                                    boolean horizontal,
                                    FormulaParseContext context)

Specified by:

extendPtgs in interface FormulaEngine

Returns:

shiftPtgs

public FormulaExpression shiftPtgs(FormulaExpression fe,
                                   int rowOffset,
                                   int columnOffset,
                                   FormulaParseContext context)

Description copied from interface: FormulaEngine

Shift the formula base on the offset

Specified by:

shiftPtgs in interface FormulaEngine

Returns:

transposePtgs

public FormulaExpression transposePtgs(FormulaExpression fe,
                                       int rowOrigin,
                                       int columnOrigin,
                                       FormulaParseContext context)

Description copied from interface: FormulaEngine

Transpose the formula base one the origin

Specified by:

transposePtgs in interface FormulaEngine

Returns:

renameSheetPtgs

public FormulaExpression renameSheetPtgs(FormulaExpression fe,
                                         SBook targetBook,
                                         String oldSheetName,
                                         String newSheetName,
                                         FormulaParseContext context)

Specified by:

renameSheetPtgs in interface FormulaEngine

Returns:

renameNamePtgs

public FormulaExpression renameNamePtgs(FormulaExpression fe,
                                        SBook targetBook,
                                        int sheetIndex,
                                        String oldName,
                                        String newName,
                                        FormulaParseContext context)

Specified by:

renameNamePtgs in interface FormulaEngine

Returns:

updateDependencyTable

public void updateDependencyTable(FormulaExpression fexpr,
                                  FormulaParseContext context)

Specified by:

updateDependencyTable in interface FormulaEngine

evaluateFormulaExpression

@Deprecated
protected org.zkoss.poi.ss.formula.eval.ValueEval evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator,
                                                                                        int sheetIndex,
                                                                                        FormulaExpression expr,
                                                                                        boolean ignoreDereference,
                                                                                        Ref dependent)

Deprecated.

evaluateFormulaExpression

@Deprecated
protected org.zkoss.poi.ss.formula.eval.ValueEval evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator,
                                                                                        int sheetIndex,
                                                                                        FormulaExpression expr,
                                                                                        boolean ignoreDereference,
                                                                                        Ref dependent,
                                                                                        int[] offset)

Deprecated.

evaluateFormulaExpression

protected org.zkoss.poi.ss.formula.eval.ValueEval evaluateFormulaExpression(org.zkoss.poi.ss.formula.WorkbookEvaluator evaluator,
                                                                            int sheetIndex,
                                                                            int rowIndex,
                                                                            int columnIndex,
                                                                            FormulaExpression expr,
                                                                            boolean ignoreDereference,
                                                                            Ref dependent,
                                                                            int[] offset)

reorderSheetPtgs

public FormulaExpression reorderSheetPtgs(FormulaExpression fexpr,
                                          SBook targetBook,
                                          int oldIndex,
                                          int newIndex,
                                          FormulaParseContext context)

Specified by:

reorderSheetPtgs in interface FormulaEngine

getReorderSheetAdjuster

protected FormulaEngineImpl.FormulaAdjuster getReorderSheetAdjuster(SBook targetBook,
                                                                    int oldIndex,
                                                                    int newIndex)

renameTableNameTablePtgs

public FormulaExpression renameTableNameTablePtgs(FormulaExpression fexpr,
                                                  SBook book,
                                                  String oldName,
                                                  String newName,
                                                  FormulaParseContext context)

Specified by:

renameTableNameTablePtgs in interface FormulaEngine

Returns:

renameColumnNameTablePtgs

public FormulaExpression renameColumnNameTablePtgs(FormulaExpression fexpr,
                                                   STable table,
                                                   String oldName,
                                                   String newName,
                                                   FormulaParseContext context)

Specified by:

renameColumnNameTablePtgs in interface FormulaEngine

Returns: