org.zkoss.zssex.formula

Class FormulaEngineEx

java.lang.Object

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

org.zkoss.zssex.formula.FormulaEngineEx

All Implemented Interfaces:

java.io.Serializable, FormulaEngine

public class FormulaEngineEx
extends FormulaEngineImpl
implements FormulaEngine

A implementation of Formula Engine with XEL context. Let formula engine support user defined function, EL variable evaluation ant so on.

Author:

Pao

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl

FormulaEngineImpl.EvalContext, FormulaEngineImpl.EvaluationResultImpl, FormulaEngineImpl.FormulaAdjuster, FormulaEngineImpl.FormulaExpressionImpl

Field Summary

Fields inherited from class org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl

KEY_EVALUATORS, 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
FormulaEngineEx()

Method Summary

Modifier and Type	Method and Description
protected ValueEval	evaluateFormulaExpression(WorkbookEvaluator evaluator, int sheetIndex, FormulaExpression expr, boolean ignoreDereference, Ref ref)
FormulaExpression	extendPtgs(FormulaExpression fe, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
protected FormulaEngineImpl.FormulaAdjuster	getRenameColumnAdjuster(java.lang.String tableName, java.lang.String oldName, java.lang.String newName)
protected FormulaEngineImpl.FormulaAdjuster	getRenameTableAdjuster(java.lang.String oldName, java.lang.String newName)
protected java.lang.Object	getXelContext()
FormulaExpression	movePtgs(FormulaExpression fe, SheetRegion region, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula that care on sheet and region.
protected Ptg[]	parse(java.lang.String formula, FormulaParsingWorkbook book, int sheetIndex, FormulaParseContext context)
FormulaExpression	renameColumnNameTablePtgs(FormulaExpression fe, STable table, java.lang.String oldName, java.lang.String newName, FormulaParseContext context)
FormulaExpression	renameNamePtgs(FormulaExpression fe, SBook targetBook, int sheetIndex, java.lang.String oldName, java.lang.String newName, FormulaParseContext context)
FormulaExpression	renameSheetPtgs(FormulaExpression fe, SBook targetBook, java.lang.String oldSheetName, java.lang.String newSheetName, FormulaParseContext context)
FormulaExpression	renameTableNameTablePtgs(FormulaExpression fe, SBook book, java.lang.String oldName, java.lang.String newName, FormulaParseContext context)
protected java.lang.String	renderFormula(ParsingBook parsingBook, java.lang.String formula, Ptg[] tokens, boolean always)
protected void	setXelContext(java.lang.Object ctx)
FormulaExpression	shiftPtgs(FormulaExpression fe, int rowOffset, int columnOffset, FormulaParseContext context) Shift the formula base on the offset
FormulaExpression	shrinkPtgs(FormulaExpression fe, SheetRegion srcRegion, boolean horizontal, FormulaParseContext context)
FormulaExpression	transposePtgs(FormulaExpression fe, int rowOrigin, int columnOrigin, FormulaParseContext context) Transpose the formula base one the origin

Methods inherited from class org.zkoss.zss.model.impl.sys.formula.FormulaEngineImpl

clearCache, convertToEvaluationResult, evaluate, evaluateFormula, evaluateFormulaExpression, evaluateFormulaExpression, extend, getMoveAdjuster, getRenameNameAdjuster, getRenameSheetAdjuster, getReorderSheetAdjuster, getResolvedValue, getShiftAdjuster, getTransposeAdjuster, move, parse, renameName, renameName, renameSheet, reorderSheetPtgs, shift, shrink, toDependRef, transpose, updateDependencyTable

Methods inherited from class java.lang.Object

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

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

clearCache, evaluate, extend, move, parse, renameName, renameName, renameSheet, reorderSheetPtgs, shift, shrink, transpose, updateDependencyTable

Constructor Detail

FormulaEngineEx

public FormulaEngineEx()

Method Detail

getXelContext

protected java.lang.Object getXelContext()

Overrides:

getXelContext in class FormulaEngineImpl

setXelContext

protected void setXelContext(java.lang.Object ctx)

Overrides:

setXelContext in class FormulaEngineImpl

renderFormula

protected java.lang.String renderFormula(ParsingBook parsingBook,
                                         java.lang.String formula,
                                         Ptg[] tokens,
                                         boolean always)

Overrides:

renderFormula in class FormulaEngineImpl

parse

protected Ptg[] parse(java.lang.String formula,
                      FormulaParsingWorkbook book,
                      int sheetIndex,
                      FormulaParseContext context)

Overrides:

parse in class FormulaEngineImpl

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

Overrides:

movePtgs in class FormulaEngineImpl

Returns:

shrinkPtgs

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

Specified by:

shrinkPtgs in interface FormulaEngine

Overrides:

shrinkPtgs in class FormulaEngineImpl

Returns:

extendPtgs

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

Specified by:

extendPtgs in interface FormulaEngine

Overrides:

extendPtgs in class FormulaEngineImpl

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

Overrides:

shiftPtgs in class FormulaEngineImpl

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

Overrides:

transposePtgs in class FormulaEngineImpl

Returns:

renameSheetPtgs

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

Specified by:

renameSheetPtgs in interface FormulaEngine

Overrides:

renameSheetPtgs in class FormulaEngineImpl

Returns:

renameNamePtgs

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

Specified by:

renameNamePtgs in interface FormulaEngine

Overrides:

renameNamePtgs in class FormulaEngineImpl

Returns:

evaluateFormulaExpression

protected ValueEval evaluateFormulaExpression(WorkbookEvaluator evaluator,
                                              int sheetIndex,
                                              FormulaExpression expr,
                                              boolean ignoreDereference,
                                              Ref ref)

Overrides:

evaluateFormulaExpression in class FormulaEngineImpl

renameTableNameTablePtgs

public FormulaExpression renameTableNameTablePtgs(FormulaExpression fe,
                                                  SBook book,
                                                  java.lang.String oldName,
                                                  java.lang.String newName,
                                                  FormulaParseContext context)

Specified by:

renameTableNameTablePtgs in interface FormulaEngine

Overrides:

renameTableNameTablePtgs in class FormulaEngineImpl

Returns:

getRenameTableAdjuster

protected FormulaEngineImpl.FormulaAdjuster getRenameTableAdjuster(java.lang.String oldName,
                                                                   java.lang.String newName)

renameColumnNameTablePtgs

public FormulaExpression renameColumnNameTablePtgs(FormulaExpression fe,
                                                   STable table,
                                                   java.lang.String oldName,
                                                   java.lang.String newName,
                                                   FormulaParseContext context)

Specified by:

renameColumnNameTablePtgs in interface FormulaEngine

Overrides:

renameColumnNameTablePtgs in class FormulaEngineImpl

Returns:

getRenameColumnAdjuster

protected FormulaEngineImpl.FormulaAdjuster getRenameColumnAdjuster(java.lang.String tableName,
                                                                    java.lang.String oldName,
                                                                    java.lang.String newName)