org.zkoss.poi.ss.formula

Interface FormulaParsingWorkbook

All Known Implementing Classes:

EvalBook, HSSFEvaluationWorkbook, ParsingBook, XSSFEvaluationWorkbook

public interface FormulaParsingWorkbook

Abstracts a workbook for the purpose of formula parsing.
For POI internal use only

Author:

Josh Micich

Method Summary

Modifier and Type	Method and Description
TablePtg	createTablePtg(String tableName, Object[] specifiers, int sheetIndex, int rowIdx, int colIdx)
String	getBookNameFromExternalLinkIndex(String externalLinkIndex) Return the associated book name of the specified ExternalLink index.
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()
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
NameXPtg	getNameXPtg(String name)
EvaluationName	getOrCreateName(String name, int sheetIndex) named range name matching is case insensitive
SpreadsheetVersion	getSpreadsheetVersion() Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)
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.
boolean	isAllowedDeferredNamePtg() In HSSF, we need to render a formula string from stored Ptg, so a formula cannot be parsed to DeferredNamePtg.

Method Detail

getName

EvaluationName getName(String name,
                       int sheetIndex)

named range name matching is case insensitive

getNameXPtg

NameXPtg getNameXPtg(String name)

getExternalSheetIndex

int getExternalSheetIndex(String sheetName)

gets the externSheet index for a sheet from this workbook

getExternalSheetIndex

int getExternalSheetIndex(String workbookName,
                          String sheetName)

gets the externSheet index for a sheet from an external workbook

Parameters:

workbookName - e.g. "Budget.xls"

sheetName - a name of a sheet in that workbook

getSpreadsheetVersion

SpreadsheetVersion getSpreadsheetVersion()

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

getBookNameFromExternalLinkIndex

String getBookNameFromExternalLinkIndex(String externalLinkIndex)

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

Parameters:

externalLinkIndex - external link index

Returns:

the associated book name of the specified ExternalLink index.

getOrCreateName

EvaluationName getOrCreateName(String name,
                               int sheetIndex)

named range name matching is case insensitive

isAllowedDeferredNamePtg

boolean isAllowedDeferredNamePtg()

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.

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

EvaluationName getName(String name,
                       String sheetName)

named range name matching is case insensitive

Since:

3.9.5

createTablePtg

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

Parameters:

tableName -

specifiers -

sheetIndex -

rowIdx -

colIdx -

Returns:

Since:

3.9.7, 3.9.7

getTableName

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.

Parameters:

name -

Returns:

Since:

3.9.7

getFormulaParsingCache

Map<String,Formula> getFormulaParsingCache()