Package io.keikai.model.impl.sys.formula

Class FormulaEngineImpl

java.lang.Object

io.keikai.model.impl.sys.formula.FormulaEngineImpl

All Implemented Interfaces:

FormulaEngine

public abstract class FormulaEngineImpl
extends Object
implements FormulaEngine

Stub base class. The Rust engine (FormulaEngineRust) extends this and overrides parse(java.lang.String, io.keikai.model.sys.formula.FormulaParseContext), evaluate(io.keikai.model.sys.formula.FormulaExpression, io.keikai.model.sys.formula.FormulaEvaluationContext), and renameSheetPtgs(io.keikai.model.sys.formula.FormulaExpression, io.keikai.model.SBook, java.lang.String, java.lang.String, io.keikai.model.sys.formula.FormulaParseContext); every other method here is a no-op pass-through.

Field Summary

Fields inherited from interface io.keikai.model.sys.formula.FormulaEngine

KEY_EXTERNAL_BOOK_NAMES, KEY_FORMULA_CACHE, KEY_SHEET_INDEXES

Constructor Summary

Constructors

Constructor	Description
FormulaEngineImpl()

Method Summary

Modifier and Type	Method	Description
void	clearCache(FormulaClearContext context)
void	clearColumnCache(FormulaClearContext context, int start, int end)
FormulaExpression	cloneSheet(String formula, SBook book, String oldName, String newName, FormulaParseContext context)
FormulaExpression	cloneSheetPtgs(FormulaExpression fexpr, SBook book, String oldName, String newName, FormulaParseContext context)
EvaluationResult	evaluate(FormulaExpression expr, FormulaEvaluationContext context)
void	evaluateOnly(FormulaExpression expr, FormulaEvaluationContext context)	Evaluates the expression only, without returning the result.
FormulaExpression	extend(String formula, SheetRegion srcRegion, boolean hrizontal, FormulaParseContext context)
FormulaExpression	extendPtgs(FormulaExpression fexpr, SheetRegion srcRegion, boolean hrizontal, FormulaParseContext context)	modify FormulaExpression for cells insertion
FormulaExpression	move(String formula, SheetRegion srcRegion, int rowOffset, int columnOffset, FormulaParseContext context)	Shift the formula that care on sheet and region.
FormulaExpression	movePtgs(FormulaExpression fexpr, SheetRegion srcRegion, int rowOffset, int columnOffset, FormulaParseContext context)	Shift the formula that care on sheet and region for cells insertion, deletion, and paste
FormulaExpression	parse(String formula, FormulaParseContext context)
FormulaExpression	renameColumnNameTablePtgs(FormulaExpression fexpr, STable table, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameName(String formula, SBook book, int sheetIndex, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameName(String formula, SBook book, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameNamePtgs(FormulaExpression fexpr, SBook book, int sheetIndex, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameSheet(String formula, SBook book, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameSheetPtgs(FormulaExpression fexpr, SBook book, String oldName, String newName, FormulaParseContext context)
FormulaExpression	renameTableNameTablePtgs(FormulaExpression fexpr, SBook book, String oldName, String newName, FormulaParseContext context)
FormulaExpression	reorderSheetPtgs(FormulaExpression fexpr, SBook book, int oldIndex, int newIndex, FormulaParseContext context)
FormulaExpression	shift(String formula, int rowOffset, int columnOffset, FormulaParseContext context)	Shift the formula base on the offset
FormulaExpression	shiftPtgs(FormulaExpression fexpr, int rowOffset, int columnOffset, FormulaParseContext context)	Shift the formula base on the offset
FormulaExpression	shrink(String formula, SheetRegion srcRegion, boolean hrizontal, FormulaParseContext context)
FormulaExpression	shrinkPtgs(FormulaExpression fexpr, SheetRegion srcRegion, boolean hrizontal, FormulaParseContext context)	modify FormulaExpression for cells deletion
FormulaExpression	transpose(String formula, int rowOrigin, int columnOrigin, FormulaParseContext context)	Transpose the formula base one the origin
FormulaExpression	transposePtgs(FormulaExpression fexpr, 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

Methods inherited from interface io.keikai.model.sys.formula.FormulaEngine

evaluateArray

Constructor Details

FormulaEngineImpl

public FormulaEngineImpl()

Method Details

parse

public FormulaExpression parse(String formula,
 FormulaParseContext context)

Specified by:

parse 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:

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:

move

public FormulaExpression move(String formula,
 SheetRegion srcRegion,
 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:

shrink

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

Specified by:

shrink in interface FormulaEngine

extend

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

Specified by:

extend in interface FormulaEngine

renameSheet

public FormulaExpression renameSheet(String formula,
 SBook book,
 String oldName,
 String newName,
 FormulaParseContext context)

Specified by:

renameSheet in interface FormulaEngine

renameName

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

Specified by:

renameName in interface FormulaEngine

renameName

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

Specified by:

renameName in interface FormulaEngine

Returns:

cloneSheet

public FormulaExpression cloneSheet(String formula,
 SBook book,
 String oldName,
 String newName,
 FormulaParseContext context)

Specified by:

cloneSheet in interface FormulaEngine

evaluate

public EvaluationResult evaluate(FormulaExpression expr,
 FormulaEvaluationContext context)

Specified by:

evaluate in interface FormulaEngine

evaluateOnly

public void evaluateOnly(FormulaExpression expr,
 FormulaEvaluationContext context)

Description copied from interface: FormulaEngine

Evaluates the expression only, without returning the result.

Specified by:

evaluateOnly in interface FormulaEngine

clearCache

public void clearCache(FormulaClearContext context)

Specified by:

clearCache in interface FormulaEngine

clearColumnCache

public void clearColumnCache(FormulaClearContext context,
 int start,
 int end)

Specified by:

clearColumnCache in interface FormulaEngine

shiftPtgs

public FormulaExpression shiftPtgs(FormulaExpression fexpr,
 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 fexpr,
 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:

movePtgs

public FormulaExpression movePtgs(FormulaExpression fexpr,
 SheetRegion srcRegion,
 int rowOffset,
 int columnOffset,
 FormulaParseContext context)

Description copied from interface: FormulaEngine

Shift the formula that care on sheet and region for cells insertion, deletion, and paste

Specified by:

movePtgs in interface FormulaEngine

Returns:

shrinkPtgs

public FormulaExpression shrinkPtgs(FormulaExpression fexpr,
 SheetRegion srcRegion,
 boolean hrizontal,
 FormulaParseContext context)

Description copied from interface: FormulaEngine

modify FormulaExpression for cells deletion

Specified by:

shrinkPtgs in interface FormulaEngine

Returns:

extendPtgs

public FormulaExpression extendPtgs(FormulaExpression fexpr,
 SheetRegion srcRegion,
 boolean hrizontal,
 FormulaParseContext context)

Description copied from interface: FormulaEngine

modify FormulaExpression for cells insertion

Specified by:

extendPtgs in interface FormulaEngine

Returns:

renameSheetPtgs

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

Specified by:

renameSheetPtgs in interface FormulaEngine

Returns:

cloneSheetPtgs

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

Specified by:

cloneSheetPtgs in interface FormulaEngine

Returns:

renameNamePtgs

public FormulaExpression renameNamePtgs(FormulaExpression fexpr,
 SBook book,
 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

reorderSheetPtgs

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

Specified by:

reorderSheetPtgs in interface FormulaEngine

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: