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

Class EvalBook

java.lang.Object

io.keikai.model.impl.sys.formula.EvalBook

All Implemented Interfaces:

Serializable, EvaluationWorkbook, FormulaParsingWorkbook

public final class EvalBook
extends Object
implements EvaluationWorkbook, FormulaParsingWorkbook, Serializable

modified from org.apache.poi.xssf.usermodel.XSSFEvaluationWorkbook

Author:

Josh Micich, Pao

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.EvaluationWorkbook

EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet, EvaluationWorkbook.ExternalSheetRange

Constructor Summary

Constructors

Constructor	Description
EvalBook(SBook book)

Method Summary

Modifier and Type	Method	Description
void	clearAllCachedResultValues()	Propagated from WorkbookEvaluator.clearAllCachedResultValues() to clear locally cached data.
int	convertFromExternSheetIndex(int externSheetIndex)	HSSF Only - convert an external sheet index to an internal sheet index, for an external-style reference to one of this workbook's own sheets
int	convertLastIndexFromExternSheetIndex(int externSheetIndex)
Name	createName()	Return the underlying workbook
TablePtg	createTablePtg(String tableName, Object[] specifiers, int sheetIndex, int rowIdx, int colIdx)
Ptg	get3DReferencePtg(AreaReference area, SheetIdentifier sheet)	Produce the appropriate Ptg for a 3d area reference
Ptg	get3DReferencePtg(CellReference cell, SheetIdentifier sheet)	Produce the appropriate Ptg for a 3d cell reference
String	getBookNameFromExternalLinkIndex(String externalLinkIndex)	Return the associated book name of the specified ExternalLink index.
EvaluationWorkbook.ExternalName	getExternalName(int externSheetIndex, int externNameIndex)	HSSF Only - fetch the external-style name details
EvaluationWorkbook.ExternalName	getExternalName(String nameName, String sheetName, int externalWorkbookNumber)	XSSF Only - fetch the external-style name details
EvaluationWorkbook.ExternalSheet	getExternalSheet(int externSheetIndex)	HSSF Only - fetch the external-style sheet details
EvaluationWorkbook.ExternalSheet	getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber)	XSSF Only - fetch the external-style sheet details
int	getExternalSheetIndex(String sheetName)	gets the externSheet index for a sheet from this workbook
int	getExternalSheetIndex(String workbookName, String sheetName)	gets the externSheet index for a sheet from an external workbook
Map<String,Formula>	getFormulaParsingCache()
Ptg[]	getFormulaTokens(int sheetIndex, String formula)
Ptg[]	getFormulaTokens(EvaluationCell cell)
EvaluationName	getName(String name, int sheetIndex)	named range name matching is case insensitive
EvaluationName	getName(String name, String sheetName)	named range name matching is case-insensitive
EvaluationName	getName(NamePtg namePtg)
EvaluationName	getName(NamePtg namePtg, int contextSheetIndex)
Ptg	getNameXPtg(String name, SheetIdentifier sheet)	Return an external name (named range, function, user-defined function) Ptg
SBook	getNBook()
EvaluationName	getOrCreateName(String name, int sheetIndex)
EvaluationSheet	getSheet(int sheetIndex)	Get the sheet identified by the given 0-based index.
int	getSheetIndex(String sheetName)	Finds a sheet index by case insensitive name.
int	getSheetIndex(EvaluationSheet evalSheet)
String	getSheetName(int sheetIndex)	Returns the name of the sheet at the given 0-based index.
SpreadsheetVersion	getSpreadsheetVersion()	Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)
Table	getTable(String name)	XSSF Only - gets a table that exists in the worksheet
String	getTableName(String name)	Given a name and return the real table name(consider uppercase/lowecase); It can be used to check whether the specified name is a table name if the returned name is null.
UDFFinder	getUDFFinder()
boolean	isAllowedDeferredNamePtg()	In HSSF, we need to render a formula string from stored Ptg, so a formula cannot be parsed to DeferredNamePtg.
String	resolveNameXText(NameXPtg n)

Methods inherited from class java.lang.Object

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

Constructor Detail

EvalBook

public EvalBook(SBook book)

Method Detail

getNBook

public SBook getNBook()

getFormulaTokens

public Ptg[] getFormulaTokens(EvaluationCell cell)

Specified by:

getFormulaTokens in interface EvaluationWorkbook

getFormulaTokens

public Ptg[] getFormulaTokens(int sheetIndex,
                              String formula)

Specified by:

getFormulaTokens in interface EvaluationWorkbook

getName

public EvaluationName getName(String name,
                              int sheetIndex)

Description copied from interface: FormulaParsingWorkbook

named range name matching is case insensitive

Specified by:

getName in interface EvaluationWorkbook

Specified by:

getName in interface FormulaParsingWorkbook

getName

public EvaluationName getName(NamePtg namePtg)

Specified by:

getName in interface EvaluationWorkbook

getName

public EvaluationName getName(NamePtg namePtg,
                              int contextSheetIndex)

getExternalName

public EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex,
                                                       int externNameIndex)

Description copied from interface: EvaluationWorkbook

HSSF Only - fetch the external-style name details

Specified by:

getExternalName in interface EvaluationWorkbook

getUDFFinder

public UDFFinder getUDFFinder()

Specified by:

getUDFFinder in interface EvaluationWorkbook

getSheet

public EvaluationSheet getSheet(int sheetIndex)

Description copied from interface: EvaluationWorkbook

Get the sheet identified by the given 0-based index.

Specified by:

getSheet in interface EvaluationWorkbook

Parameters:

sheetIndex - The 0-based index of the sheet

Returns:

The sheet

getSheetIndex

public int getSheetIndex(EvaluationSheet evalSheet)

Specified by:

getSheetIndex in interface EvaluationWorkbook

Returns:

-1 if the specified sheet is from a different book

getSheetIndex

public int getSheetIndex(String sheetName)

Description copied from interface: EvaluationWorkbook

Finds a sheet index by case insensitive name.

Specified by:

getSheetIndex in interface EvaluationWorkbook

Returns:

the index of the sheet matching the specified name. -1 if not found

getSheetName

public String getSheetName(int sheetIndex)

Description copied from interface: EvaluationWorkbook

Returns the name of the sheet at the given 0-based index.

Specified by:

getSheetName in interface EvaluationWorkbook

Parameters:

sheetIndex - The 0-based index of the sheet

Returns:

The name of the sheet

getExternalSheet

public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Description copied from interface: EvaluationWorkbook

HSSF Only - fetch the external-style sheet details

Return will have no workbook set if it's actually in our own workbook

Specified by:

getExternalSheet in interface EvaluationWorkbook

Returns:

The found sheet or null if not found

resolveNameXText

public String resolveNameXText(NameXPtg n)

Specified by:

resolveNameXText in interface EvaluationWorkbook

convertFromExternSheetIndex

public int convertFromExternSheetIndex(int externSheetIndex)

Description copied from interface: EvaluationWorkbook

HSSF Only - convert an external sheet index to an internal sheet index, for an external-style reference to one of this workbook's own sheets

Specified by:

convertFromExternSheetIndex in interface EvaluationWorkbook

Returns:

the sheet index of the sheet with the given external index.

convertLastIndexFromExternSheetIndex

public int convertLastIndexFromExternSheetIndex(int externSheetIndex)

Specified by:

convertLastIndexFromExternSheetIndex in interface EvaluationWorkbook

getExternalSheetIndex

public int getExternalSheetIndex(String sheetName)

Description copied from interface: FormulaParsingWorkbook

gets the externSheet index for a sheet from this workbook

Specified by:

getExternalSheetIndex in interface FormulaParsingWorkbook

getExternalSheetIndex

public int getExternalSheetIndex(String workbookName,
                                 String sheetName)

Description copied from interface: FormulaParsingWorkbook

gets the externSheet index for a sheet from an external workbook

Specified by:

getExternalSheetIndex in interface FormulaParsingWorkbook

Parameters:

workbookName - e.g. "Budget.xls"

sheetName - a name of a sheet in that workbook

getExternalSheet

public EvaluationWorkbook.ExternalSheet getExternalSheet(String firstSheetName,
                                                         String lastSheetName,
                                                         int externalWorkbookNumber)

Description copied from interface: EvaluationWorkbook

XSSF Only - fetch the external-style sheet details

Return will have no workbook set if it's actually in our own workbook

Specified by:

getExternalSheet in interface EvaluationWorkbook

Returns:

The found sheet

getExternalName

public EvaluationWorkbook.ExternalName getExternalName(String nameName,
                                                       String sheetName,
                                                       int externalWorkbookNumber)

Description copied from interface: EvaluationWorkbook

XSSF Only - fetch the external-style name details

Specified by:

getExternalName in interface EvaluationWorkbook

clearAllCachedResultValues

public void clearAllCachedResultValues()

Description copied from interface: EvaluationWorkbook

Propagated from WorkbookEvaluator.clearAllCachedResultValues() to clear locally cached data. Implementations must call the same method on all referenced EvaluationSheet instances, as well as clearing local caches.

Specified by:

clearAllCachedResultValues in interface EvaluationWorkbook

See Also:

WorkbookEvaluator.clearAllCachedResultValues()

createName

public Name createName()

Description copied from interface: FormulaParsingWorkbook

Return the underlying workbook

Specified by:

createName in interface FormulaParsingWorkbook

getTable

public Table getTable(String name)

Description copied from interface: FormulaParsingWorkbook

XSSF Only - gets a table that exists in the worksheet

Specified by:

getTable in interface FormulaParsingWorkbook

getNameXPtg

public Ptg getNameXPtg(String name,
                       SheetIdentifier sheet)

Description copied from interface: FormulaParsingWorkbook

Return an external name (named range, function, user-defined function) Ptg

Specified by:

getNameXPtg in interface FormulaParsingWorkbook

get3DReferencePtg

public Ptg get3DReferencePtg(CellReference cell,
                             SheetIdentifier sheet)

Description copied from interface: FormulaParsingWorkbook

Produce the appropriate Ptg for a 3d cell reference

Specified by:

get3DReferencePtg in interface FormulaParsingWorkbook

get3DReferencePtg

public Ptg get3DReferencePtg(AreaReference area,
                             SheetIdentifier sheet)

Description copied from interface: FormulaParsingWorkbook

Produce the appropriate Ptg for a 3d area reference

Specified by:

get3DReferencePtg in interface FormulaParsingWorkbook

getSpreadsheetVersion

public SpreadsheetVersion getSpreadsheetVersion()

Description copied from interface: FormulaParsingWorkbook

Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)

Specified by:

getSpreadsheetVersion in interface EvaluationWorkbook

Specified by:

getSpreadsheetVersion in interface FormulaParsingWorkbook

getBookNameFromExternalLinkIndex

public String getBookNameFromExternalLinkIndex(String externalLinkIndex)

Description copied from interface: FormulaParsingWorkbook

Return the associated book name of the specified ExternalLink index. Excel stores ExternalLink index in place of the [].(e.g. [1]Sheet1:Sheet3!xxx)

Specified by:

getBookNameFromExternalLinkIndex in interface FormulaParsingWorkbook

Parameters:

externalLinkIndex - external link index

Returns:

the associated book name of the specified ExternalLink index.

getOrCreateName

public EvaluationName getOrCreateName(String name,
                                      int sheetIndex)

isAllowedDeferredNamePtg

public boolean isAllowedDeferredNamePtg()

Description copied from interface: FormulaParsingWorkbook

In HSSF, we need to render a formula string from stored Ptg, so a formula cannot be parsed to DeferredNamePtg. Because DeferredNamePtg will be read as UnknownPtg for it's not written out.

Specified by:

isAllowedDeferredNamePtg in interface FormulaParsingWorkbook

Returns:

true for using DeferredNamePtg to represent a non-existed defined name during formula parsing. If false, parser will create a defined name for a non-existed one.

getName

public EvaluationName getName(String name,
                              String sheetName)

Description copied from interface: FormulaParsingWorkbook

named range name matching is case-insensitive

Specified by:

getName in interface FormulaParsingWorkbook

createTablePtg

public TablePtg createTablePtg(String tableName,
                               Object[] specifiers,
                               int sheetIndex,
                               int rowIdx,
                               int colIdx)

Specified by:

createTablePtg in interface FormulaParsingWorkbook

Returns:

getTableName

public String getTableName(String name)

Description copied from interface: FormulaParsingWorkbook

Given a name and return the real table name(consider uppercase/lowecase); It can be used to check whether the specified name is a table name if the returned name is null.

Specified by:

getTableName in interface FormulaParsingWorkbook

Returns:

getFormulaParsingCache

public Map<String,Formula> getFormulaParsingCache()