Package org.apache.poi.ss.formula
Interface EvaluationWorkbook
- All Known Implementing Classes:
BaseXSSFEvaluationWorkbook
,HSSFEvaluationWorkbook
,SXSSFEvaluationWorkbook
,XSSFEvaluationWorkbook
Abstracts a workbook for the purpose of formula evaluation.
For POI internal use only
For POI internal use only
- Author:
- Josh Micich
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
static class
static class
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Propagated fromWorkbookEvaluator.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 sheetsgetExternalName
(int externSheetIndex, int externNameIndex) HSSF Only - fetch the external-style name detailsgetExternalName
(String nameName, String sheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style name detailsgetExternalSheet
(int externSheetIndex) HSSF Only - fetch the external-style sheet detailsgetExternalSheet
(String firstSheetName, String lastSheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style sheet detailsPtg[]
getSheet
(int sheetIndex) int
getSheetIndex
(String sheetName) Finds a sheet index by case insensitive name.int
getSheetIndex
(EvaluationSheet sheet) getSheetName
(int sheetIndex) resolveNameXText
(NameXPtg ptg)
-
Method Details
-
getSheetName
-
getSheetIndex
- Returns:
- -1 if the specified sheet is from a different book
-
getSheetIndex
Finds a sheet index by case insensitive name.- Returns:
- the index of the sheet matching the specified name. -1 if not found
-
getSheet
-
getExternalSheet
HSSF Only - fetch the external-style sheet detailsReturn will have no workbook set if it's actually in our own workbook
-
getExternalSheet
EvaluationWorkbook.ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style sheet detailsReturn will have no workbook set if it's actually in our own workbook
-
convertFromExternSheetIndex
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 -
getExternalName
HSSF Only - fetch the external-style name details -
getExternalName
EvaluationWorkbook.ExternalName getExternalName(String nameName, String sheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style name details -
getName
-
getName
-
resolveNameXText
-
getFormulaTokens
-
getUDFFinder
UDFFinder getUDFFinder() -
getSpreadsheetVersion
SpreadsheetVersion getSpreadsheetVersion() -
clearAllCachedResultValues
void clearAllCachedResultValues()Propagated fromWorkbookEvaluator.clearAllCachedResultValues()
to clear locally cached data. Implementations must call the same method on all referencedEvaluationSheet
instances, as well as clearing local caches.- Since:
- POI 3.15 beta 3
- See Also:
-