@Internal public abstract class BaseXSSFEvaluationWorkbook extends java.lang.Object implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook
EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet, EvaluationWorkbook.ExternalSheetRange
Modifier and Type | Field and Description |
---|---|
protected XSSFWorkbook |
_uBook |
Modifier | Constructor and Description |
---|---|
protected |
BaseXSSFEvaluationWorkbook(XSSFWorkbook book) |
Modifier and Type | Method and Description |
---|---|
void |
clearAllCachedResultValues()
Propagated from
WorkbookEvaluator.clearAllCachedResultValues() to clear locally cached data. |
int |
convertFromExternSheetIndex(int externSheetIndex)
XSSF doesn't use external sheet indexes, so when asked treat
it just as a local index
|
XSSFName |
createName()
Return the underlying workbook
|
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
|
EvaluationWorkbook.ExternalName |
getExternalName(int externSheetIndex,
int externNameIndex)
HSSF Only - fetch the external-style name details
|
EvaluationWorkbook.ExternalName |
getExternalName(java.lang.String nameName,
java.lang.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(java.lang.String firstSheetName,
java.lang.String lastSheetName,
int externalWorkbookNumber)
XSSF Only - fetch the external-style sheet details
|
int |
getExternalSheetIndex(java.lang.String sheetName)
gets the externSheet index for a sheet from this workbook
|
int |
getExternalSheetIndex(java.lang.String workbookName,
java.lang.String sheetName)
gets the externSheet index for a sheet from an external workbook
|
EvaluationName |
getName(NamePtg namePtg) |
EvaluationName |
getName(java.lang.String name,
int sheetIndex)
Return EvaluationName wrapper around the matching XSSFName (named range)
|
java.lang.String |
getNameText(NamePtg namePtg) |
NameXPxg |
getNameXPtg(java.lang.String name,
SheetIdentifier sheet)
Return an external name (named range, function, user-defined function) Pxg
|
java.lang.String |
getSheetFirstNameByExternSheet(int externSheetIndex) |
int |
getSheetIndex(java.lang.String sheetName)
Finds a sheet index by case insensitive name.
|
java.lang.String |
getSheetLastNameByExternSheet(int externSheetIndex) |
java.lang.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.)
|
XSSFTable |
getTable(java.lang.String name)
Returns the data table with the given name (case insensitive).
|
UDFFinder |
getUDFFinder() |
java.lang.String |
resolveNameXText(NameXPtg n) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFormulaTokens, getSheet, getSheetIndex
protected final XSSFWorkbook _uBook
protected BaseXSSFEvaluationWorkbook(XSSFWorkbook book)
public void clearAllCachedResultValues()
EvaluationWorkbook
WorkbookEvaluator.clearAllCachedResultValues()
to clear locally cached data.
Implementations must call the same method on all referenced EvaluationSheet
instances, as well as clearing local caches.clearAllCachedResultValues
in interface EvaluationWorkbook
WorkbookEvaluator.clearAllCachedResultValues()
public int convertFromExternSheetIndex(int externSheetIndex)
convertFromExternSheetIndex
in interface EvaluationWorkbook
public int getExternalSheetIndex(java.lang.String sheetName)
FormulaParsingWorkbook
getExternalSheetIndex
in interface FormulaParsingWorkbook
public EvaluationName getName(java.lang.String name, int sheetIndex)
getName
in interface EvaluationWorkbook
getName
in interface FormulaParsingWorkbook
name
- case-aware but case-insensitive named range in workbooksheetIndex
- index of sheet if named range scope is limited to one sheet
if named range scope is global to the workbook, sheetIndex is -1.public java.lang.String getSheetName(int sheetIndex)
EvaluationWorkbook
getSheetName
in interface EvaluationWorkbook
sheetIndex
- The 0-based index of the sheetpublic EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex, int externNameIndex)
EvaluationWorkbook
getExternalName
in interface EvaluationWorkbook
public EvaluationWorkbook.ExternalName getExternalName(java.lang.String nameName, java.lang.String sheetName, int externalWorkbookNumber)
EvaluationWorkbook
getExternalName
in interface EvaluationWorkbook
public NameXPxg getNameXPtg(java.lang.String name, SheetIdentifier sheet)
getNameXPtg
in interface FormulaParsingWorkbook
public Ptg get3DReferencePtg(CellReference cell, SheetIdentifier sheet)
FormulaParsingWorkbook
get3DReferencePtg
in interface FormulaParsingWorkbook
public Ptg get3DReferencePtg(AreaReference area, SheetIdentifier sheet)
FormulaParsingWorkbook
get3DReferencePtg
in interface FormulaParsingWorkbook
public java.lang.String resolveNameXText(NameXPtg n)
resolveNameXText
in interface EvaluationWorkbook
resolveNameXText
in interface FormulaRenderingWorkbook
public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)
EvaluationWorkbook
Return will have no workbook set if it's actually in our own workbook
getExternalSheet
in interface EvaluationWorkbook
getExternalSheet
in interface FormulaRenderingWorkbook
null
if externSheetIndex refers to a sheet inside the current workbookpublic EvaluationWorkbook.ExternalSheet getExternalSheet(java.lang.String firstSheetName, java.lang.String lastSheetName, int externalWorkbookNumber)
EvaluationWorkbook
Return will have no workbook set if it's actually in our own workbook
getExternalSheet
in interface EvaluationWorkbook
@NotImplemented public int getExternalSheetIndex(java.lang.String workbookName, java.lang.String sheetName)
FormulaParsingWorkbook
getExternalSheetIndex
in interface FormulaParsingWorkbook
workbookName
- e.g. "Budget.xls"sheetName
- a name of a sheet in that workbookpublic int getSheetIndex(java.lang.String sheetName)
EvaluationWorkbook
getSheetIndex
in interface EvaluationWorkbook
public java.lang.String getSheetFirstNameByExternSheet(int externSheetIndex)
getSheetFirstNameByExternSheet
in interface FormulaRenderingWorkbook
public java.lang.String getSheetLastNameByExternSheet(int externSheetIndex)
getSheetLastNameByExternSheet
in interface FormulaRenderingWorkbook
public java.lang.String getNameText(NamePtg namePtg)
getNameText
in interface FormulaRenderingWorkbook
public EvaluationName getName(NamePtg namePtg)
getName
in interface EvaluationWorkbook
public XSSFName createName()
FormulaParsingWorkbook
createName
in interface FormulaParsingWorkbook
public XSSFTable getTable(java.lang.String name)
getTable
in interface FormulaParsingWorkbook
name
- the data table name (case-insensitive)name
, or null
if no table is named name
.public UDFFinder getUDFFinder()
getUDFFinder
in interface EvaluationWorkbook
public SpreadsheetVersion getSpreadsheetVersion()
FormulaParsingWorkbook
getSpreadsheetVersion
in interface EvaluationWorkbook
getSpreadsheetVersion
in interface FormulaParsingWorkbook
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.