EvaluationWorkbook
, FormulaParsingWorkbook
, FormulaRenderingWorkbook
public final class HSSFEvaluationWorkbook extends java.lang.Object implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook
EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet
Modifier and Type | Method | Description |
---|---|---|
int |
convertFromExternSheetIndex(int externSheetIndex) |
|
static HSSFEvaluationWorkbook |
create(HSSFWorkbook book) |
|
EvaluationWorkbook.ExternalName |
getExternalName(int externSheetIndex,
int externNameIndex) |
|
EvaluationWorkbook.ExternalSheet |
getExternalSheet(int externSheetIndex) |
|
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
|
Ptg[] |
getFormulaTokens(EvaluationCell evalCell) |
|
EvaluationName |
getName(java.lang.String name,
int sheetIndex) |
Lookup a named range by its name.
|
EvaluationName |
getName(NamePtg namePtg) |
|
java.lang.String |
getNameText(NamePtg namePtg) |
|
NameXPtg |
getNameXPtg(java.lang.String name) |
|
EvaluationSheet |
getSheet(int sheetIndex) |
|
int |
getSheetIndex(java.lang.String sheetName) |
Finds a sheet index by case insensitive name.
|
int |
getSheetIndex(EvaluationSheet evalSheet) |
|
java.lang.String |
getSheetName(int sheetIndex) |
|
java.lang.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.)
|
UDFFinder |
getUDFFinder() |
|
java.lang.String |
resolveNameXText(NameXPtg n) |
public static HSSFEvaluationWorkbook create(HSSFWorkbook book)
public int getExternalSheetIndex(java.lang.String sheetName)
FormulaParsingWorkbook
getExternalSheetIndex
in interface FormulaParsingWorkbook
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 NameXPtg getNameXPtg(java.lang.String name)
getNameXPtg
in interface FormulaParsingWorkbook
public EvaluationName getName(java.lang.String name, int sheetIndex)
getName
in interface EvaluationWorkbook
getName
in interface FormulaParsingWorkbook
name
- the name to searchsheetIndex
- 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 namespublic int getSheetIndex(EvaluationSheet evalSheet)
getSheetIndex
in interface EvaluationWorkbook
public int getSheetIndex(java.lang.String sheetName)
EvaluationWorkbook
getSheetIndex
in interface EvaluationWorkbook
public java.lang.String getSheetName(int sheetIndex)
getSheetName
in interface EvaluationWorkbook
public EvaluationSheet getSheet(int sheetIndex)
getSheet
in interface EvaluationWorkbook
public int convertFromExternSheetIndex(int externSheetIndex)
convertFromExternSheetIndex
in interface EvaluationWorkbook
public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)
getExternalSheet
in interface EvaluationWorkbook
getExternalSheet
in interface FormulaRenderingWorkbook
null
if externSheetIndex refers to a sheet inside the current workbookpublic EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex, int externNameIndex)
getExternalName
in interface EvaluationWorkbook
public java.lang.String resolveNameXText(NameXPtg n)
resolveNameXText
in interface EvaluationWorkbook
resolveNameXText
in interface FormulaRenderingWorkbook
public java.lang.String getSheetNameByExternSheet(int externSheetIndex)
getSheetNameByExternSheet
in interface FormulaRenderingWorkbook
public java.lang.String getNameText(NamePtg namePtg)
getNameText
in interface FormulaRenderingWorkbook
public EvaluationName getName(NamePtg namePtg)
getName
in interface EvaluationWorkbook
public Ptg[] getFormulaTokens(EvaluationCell evalCell)
getFormulaTokens
in interface EvaluationWorkbook
public UDFFinder getUDFFinder()
getUDFFinder
in interface EvaluationWorkbook
public SpreadsheetVersion getSpreadsheetVersion()
FormulaParsingWorkbook
getSpreadsheetVersion
in interface FormulaParsingWorkbook
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.