org.zkoss.poi.ss.formula

Interface EvaluationWorkbook

All Known Implementing Classes:

EvalBook, HSSFEvaluationWorkbook, XSSFEvaluationWorkbook

public interface EvaluationWorkbook

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

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EvaluationWorkbook.ExternalName
static class	EvaluationWorkbook.ExternalSheet

Method Summary

Modifier and Type	Method and Description
int	convertFromExternSheetIndex(int externSheetIndex)
int	convertLastIndexFromExternSheetIndex(int externSheetIndex)
EvaluationWorkbook.ExternalName	getExternalName(int externSheetIndex, int externNameIndex)
EvaluationWorkbook.ExternalSheet	getExternalSheet(int externSheetIndex)
Ptg[]	getFormulaTokens(EvaluationCell cell)
Ptg[]	getFormulaTokens(int sheetIndex, String formula)
EvaluationName	getName(NamePtg namePtg)
EvaluationName	getName(NamePtg namePtg, int contextSheetIndex)
EvaluationName	getName(String name, int sheetIndex)
EvaluationSheet	getSheet(int sheetIndex)
int	getSheetIndex(EvaluationSheet sheet)
int	getSheetIndex(String sheetName) Finds a sheet index by case insensitive name.
String	getSheetName(int sheetIndex)
UDFFinder	getUDFFinder()
String	resolveNameXText(NameXPtg ptg)

Method Detail

getSheetName

String getSheetName(int sheetIndex)

getSheetIndex

int getSheetIndex(EvaluationSheet sheet)

Returns:

-1 if the specified sheet is from a different book

getSheetIndex

int getSheetIndex(String sheetName)

Finds a sheet index by case insensitive name.

Returns:

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

getSheet

EvaluationSheet getSheet(int sheetIndex)

getExternalSheet

EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Returns:

null if externSheetIndex refers to a sheet inside the current workbook

convertFromExternSheetIndex

int convertFromExternSheetIndex(int externSheetIndex)

convertLastIndexFromExternSheetIndex

int convertLastIndexFromExternSheetIndex(int externSheetIndex)

getExternalName

EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex,
                                                int externNameIndex)

getName

EvaluationName getName(NamePtg namePtg)

getName

EvaluationName getName(NamePtg namePtg,
                       int contextSheetIndex)

Parameters:

namePtg -

contextSheetIndex -

Returns:

Since:

3.9.5

getName

EvaluationName getName(String name,
                       int sheetIndex)

resolveNameXText

String resolveNameXText(NameXPtg ptg)

getFormulaTokens

Ptg[] getFormulaTokens(EvaluationCell cell)

getUDFFinder

UDFFinder getUDFFinder()

getFormulaTokens

Ptg[] getFormulaTokens(int sheetIndex,
                       String formula)