org.apache.poi.xssf.usermodel

Class XSSFEvaluationWorkbook

java.lang.Object

org.apache.poi.xssf.usermodel.XSSFEvaluationWorkbook

All Implemented Interfaces:

EvaluationWorkbook, FormulaParsingWorkbook, FormulaRenderingWorkbook

public final class XSSFEvaluationWorkbook
extends Object
implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook

Internal POI use only

Author:

Josh Micich

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.EvaluationWorkbook

EvaluationWorkbook.ExternalName, EvaluationWorkbook.ExternalSheet

Method Summary

Methods

Modifier and Type	Method and Description
int	convertFromExternSheetIndex(int externSheetIndex)
static XSSFEvaluationWorkbook	create(XSSFWorkbook book)
EvaluationWorkbook.ExternalName	getExternalName(int externSheetIndex, int externNameIndex)
EvaluationWorkbook.ExternalSheet	getExternalSheet(int externSheetIndex)
int	getExternalSheetIndex(String sheetName)
int	getExternalSheetIndex(String workbookName, String sheetName)
Ptg[]	getFormulaTokens(EvaluationCell evalCell)
EvaluationName	getName(NamePtg namePtg)
EvaluationName	getName(String name, int sheetIndex)
String	getNameText(NamePtg namePtg)
NameXPtg	getNameXPtg(String name)
EvaluationSheet	getSheet(int sheetIndex)
int	getSheetIndex(EvaluationSheet evalSheet)
int	getSheetIndex(String sheetName)
String	getSheetName(int sheetIndex)
String	getSheetNameByExternSheet(int externSheetIndex)
SpreadsheetVersion	getSpreadsheetVersion()
UDFFinder	getUDFFinder()
String	resolveNameXText(NameXPtg n)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static XSSFEvaluationWorkbook create(XSSFWorkbook book)

convertFromExternSheetIndex

public int convertFromExternSheetIndex(int externSheetIndex)

Specified by:

convertFromExternSheetIndex in interface EvaluationWorkbook

Returns:

the sheet index of the sheet with the given external index.

getExternalSheetIndex

public int getExternalSheetIndex(String sheetName)

Specified by:

getExternalSheetIndex in interface FormulaParsingWorkbook

getName

public EvaluationName getName(String name,
                     int sheetIndex)

Specified by:

getName in interface EvaluationWorkbook

Specified by:

getName in interface FormulaParsingWorkbook

getSheetIndex

public int getSheetIndex(EvaluationSheet evalSheet)

Specified by:

getSheetIndex in interface EvaluationWorkbook

getSheetName

public String getSheetName(int sheetIndex)

Specified by:

getSheetName in interface EvaluationWorkbook

getExternalName

public EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex,
                                              int externNameIndex)

Specified by:

getExternalName in interface EvaluationWorkbook

getNameXPtg

public NameXPtg getNameXPtg(String name)

Specified by:

getNameXPtg in interface FormulaParsingWorkbook

resolveNameXText

public String resolveNameXText(NameXPtg n)

Specified by:

resolveNameXText in interface EvaluationWorkbook

Specified by:

resolveNameXText in interface FormulaRenderingWorkbook

getSheet

public EvaluationSheet getSheet(int sheetIndex)

Specified by:

getSheet in interface EvaluationWorkbook

getExternalSheet

public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Specified by:

getExternalSheet in interface EvaluationWorkbook

Specified by:

getExternalSheet in interface FormulaRenderingWorkbook

getExternalSheetIndex

public int getExternalSheetIndex(String workbookName,
                        String sheetName)

Specified by:

getExternalSheetIndex in interface FormulaParsingWorkbook

getSheetIndex

public int getSheetIndex(String sheetName)

Specified by:

getSheetIndex in interface EvaluationWorkbook

getSheetNameByExternSheet

public String getSheetNameByExternSheet(int externSheetIndex)

Specified by:

getSheetNameByExternSheet in interface FormulaRenderingWorkbook

getNameText

public String getNameText(NamePtg namePtg)

Specified by:

getNameText in interface FormulaRenderingWorkbook

getName

public EvaluationName getName(NamePtg namePtg)

Specified by:

getName in interface EvaluationWorkbook

getFormulaTokens

public Ptg[] getFormulaTokens(EvaluationCell evalCell)

Specified by:

getFormulaTokens in interface EvaluationWorkbook

getUDFFinder

public UDFFinder getUDFFinder()

Specified by:

getUDFFinder in interface EvaluationWorkbook

getSpreadsheetVersion

public SpreadsheetVersion getSpreadsheetVersion()

Specified by:

getSpreadsheetVersion in interface FormulaParsingWorkbook