org.zkoss.poi.hssf.usermodel

Class HSSFEvaluationWorkbook

java.lang.Object

org.zkoss.poi.hssf.usermodel.HSSFEvaluationWorkbook

All Implemented Interfaces:

EvaluationWorkbook, FormulaParsingWorkbook, FormulaRenderingWorkbook

public final class HSSFEvaluationWorkbook
extends Object
implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook

Internal POI use only

Author:

Josh Micich, Henri Chen (henrichen at zkoss dot org) - Sheet1:Sheet3!xxx 3d reference

Nested Class Summary

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

EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet

Method Summary

Modifier and Type	Method and Description
int	convertFromExternSheetIndex(int externSheetIndex)
int	convertLastIndexFromExternSheetIndex(int externSheetIndex)
static HSSFEvaluationWorkbook	create(HSSFWorkbook book)
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.
String	getExternalLinkIndexFromBookName(String bookname)
EvaluationWorkbook.ExternalName	getExternalName(int externSheetIndex, int externNameIndex)
EvaluationWorkbook.ExternalSheet	getExternalSheet(int externSheetIndex)
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(EvaluationCell evalCell)
Ptg[]	getFormulaTokens(int sheetIndex, String formula)
String	getFullNameText(NamePtg namePtg) Return the full qualified expression.
EvaluationName	getName(NamePtg namePtg)
EvaluationName	getName(NamePtg namePtg, int contextSheetIndex)
EvaluationName	getName(String name, int sheetIndex) Lookup a named range by its name.
EvaluationName	getName(String name, String sheetName) named range name matching is case insensitive
String	getNameText(NamePtg namePtg)
NameXPtg	getNameXPtg(String name)
EvaluationName	getOrCreateName(String name, int sheetIndex) Lookup a named range by its name.
EvaluationSheet	getSheet(int sheetIndex)
int	getSheetIndex(EvaluationSheet evalSheet)
int	getSheetIndex(String sheetName) Finds a sheet index by case insensitive name.
String	getSheetName(int sheetIndex)
String	getSheetNameByExternSheet(int externSheetIndex)
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.
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

Method Detail

create

public static HSSFEvaluationWorkbook create(HSSFWorkbook book)

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

getNameXPtg

public NameXPtg getNameXPtg(String name)

Specified by:

getNameXPtg in interface FormulaParsingWorkbook

getName

public EvaluationName getName(String name,
                              int sheetIndex)

Lookup a named range by its name.

Specified by:

getName in interface EvaluationWorkbook

Specified by:

getName in interface FormulaParsingWorkbook

Parameters:

name - the name to search

sheetIndex - the 0-based index of the sheet this formula belongs to. The sheet index is required to resolve sheet-level names. -1 means workbook-global names

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)

Specified by:

getSheetName in interface EvaluationWorkbook

getSheet

public EvaluationSheet getSheet(int sheetIndex)

Specified by:

getSheet in interface EvaluationWorkbook

convertFromExternSheetIndex

public int convertFromExternSheetIndex(int externSheetIndex)

Specified by:

convertFromExternSheetIndex in interface EvaluationWorkbook

convertLastIndexFromExternSheetIndex

public int convertLastIndexFromExternSheetIndex(int externSheetIndex)

Specified by:

convertLastIndexFromExternSheetIndex in interface EvaluationWorkbook

getExternalSheet

public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Specified by:

getExternalSheet in interface EvaluationWorkbook

Specified by:

getExternalSheet in interface FormulaRenderingWorkbook

Returns:

null if externSheetIndex refers to a sheet inside the current workbook

getExternalName

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

Specified by:

getExternalName in interface EvaluationWorkbook

resolveNameXText

public String resolveNameXText(NameXPtg n)

Specified by:

resolveNameXText in interface EvaluationWorkbook

Specified by:

resolveNameXText in interface FormulaRenderingWorkbook

getSheetNameByExternSheet

public String getSheetNameByExternSheet(int externSheetIndex)

Specified by:

getSheetNameByExternSheet in interface FormulaRenderingWorkbook

getNameText

public String getNameText(NamePtg namePtg)

Specified by:

getNameText in interface FormulaRenderingWorkbook

getName

public EvaluationName getName(NamePtg namePtg)

Specified by:

getName in interface EvaluationWorkbook

getName

public EvaluationName getName(NamePtg namePtg,
                              int contextSheetIndex)

Specified by:

getName in interface EvaluationWorkbook

Returns:

getFormulaTokens

public Ptg[] getFormulaTokens(EvaluationCell evalCell)

Specified by:

getFormulaTokens in interface EvaluationWorkbook

getUDFFinder

public UDFFinder getUDFFinder()

Specified by:

getUDFFinder in interface EvaluationWorkbook

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 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)

Lookup a named range by its name.

Specified by:

getOrCreateName in interface FormulaParsingWorkbook

Parameters:

name - the name to search

sheetIndex - the 0-based index of the sheet this formula belongs to. The sheet index is required to resolve sheet-level names. -1 means workbook-global names

getFormulaTokens

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

Specified by:

getFormulaTokens in interface EvaluationWorkbook

getExternalLinkIndexFromBookName

public String getExternalLinkIndexFromBookName(String bookname)

Specified by:

getExternalLinkIndexFromBookName in interface FormulaRenderingWorkbook

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

getFullNameText

public String getFullNameText(NamePtg namePtg)

Description copied from interface: FormulaRenderingWorkbook

Return the full qualified expression.

Specified by:

getFullNameText in interface FormulaRenderingWorkbook

Returns:

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()

Specified by:

getFormulaParsingCache in interface FormulaParsingWorkbook