public final class XSSFEvaluationWorkbook extends java.lang.Object implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook
EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet, EvaluationWorkbook.ExternalSheetRange
Modifier and Type | Method and Description |
---|---|
int |
convertFromExternSheetIndex(int externSheetIndex)
XSSF doesn't use external sheet indexes, so when asked treat
it just as a local index
|
static XSSFEvaluationWorkbook |
create(XSSFWorkbook book) |
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
|
Ptg[] |
getFormulaTokens(EvaluationCell evalCell) |
EvaluationName |
getName(NamePtg namePtg) |
EvaluationName |
getName(java.lang.String name,
int sheetIndex)
named range name matching is case insensitive
|
java.lang.String |
getNameText(NamePtg namePtg) |
NameXPxg |
getNameXPtg(java.lang.String name,
SheetIdentifier sheet) |
EvaluationSheet |
getSheet(int sheetIndex) |
java.lang.String |
getSheetFirstNameByExternSheet(int externSheetIndex) |
int |
getSheetIndex(EvaluationSheet evalSheet) |
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) |
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 XSSFEvaluationWorkbook create(XSSFWorkbook book)
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)
FormulaParsingWorkbook
getName
in interface EvaluationWorkbook
getName
in interface FormulaParsingWorkbook
public int getSheetIndex(EvaluationSheet evalSheet)
getSheetIndex
in interface EvaluationWorkbook
public java.lang.String getSheetName(int sheetIndex)
getSheetName
in interface EvaluationWorkbook
public 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 EvaluationSheet getSheet(int sheetIndex)
getSheet
in interface EvaluationWorkbook
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
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 Ptg[] getFormulaTokens(EvaluationCell evalCell)
getFormulaTokens
in interface EvaluationWorkbook
public UDFFinder getUDFFinder()
getUDFFinder
in interface EvaluationWorkbook
public SpreadsheetVersion getSpreadsheetVersion()
FormulaParsingWorkbook
getSpreadsheetVersion
in interface FormulaParsingWorkbook
Copyright 2015 The Apache Software Foundation or its licensors, as applicable.