Top Description Methods
org.apache.poi.ss.formula

public Interface FormulaParsingWorkbook

Known Direct Implementers
org.apache.poi.hssf.usermodel.HSSFEvaluationWorkbook
Imports
org.apache.poi.ss.SpreadsheetVersion, org.apache.poi.ss.formula.ptg.Ptg, org.apache.poi.ss.usermodel.Name, .Table, org.apache.poi.ss.util.AreaReference, .CellReference
Abstracts a workbook for the purpose of formula parsing.
For POI internal use only

Method Summary

Modifier and TypeMethod and Description
public Name
createName()

Return the underlying workbook

public Ptg
get3DReferencePtg(CellReference cell, SheetIdentifier sheet)

Produce the appropriate Ptg for a 3d cell reference

public Ptg
get3DReferencePtg(AreaReference area, SheetIdentifier sheet)

Produce the appropriate Ptg for a 3d area reference

public int
getExternalSheetIndex(String sheetName)

gets the externSheet index for a sheet from this workbook

public int
getExternalSheetIndex(String
e.g. "Budget.xls"
workbookName, String
a name of a sheet in that workbook
sheetName)

gets the externSheet index for a sheet from an external workbook

public EvaluationName
getName(String name, int sheetIndex)

named range name matching is case insensitive

public Ptg
getNameXPtg(String name, SheetIdentifier sheet)

Return an external name (named range, function, user-defined function) Ptg

public SpreadsheetVersion
getSpreadsheetVersion()

Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)

public Table
getTable(String name)

XSSF Only - gets a table that exists in the worksheet

Method Detail

createNameback to summary
public Name createName()

Return the underlying workbook

get3DReferencePtgback to summary
public Ptg get3DReferencePtg(CellReference cell, SheetIdentifier sheet)

Produce the appropriate Ptg for a 3d cell reference

get3DReferencePtgback to summary
public Ptg get3DReferencePtg(AreaReference area, SheetIdentifier sheet)

Produce the appropriate Ptg for a 3d area reference

getExternalSheetIndexback to summary
public int getExternalSheetIndex(String sheetName)

gets the externSheet index for a sheet from this workbook

getExternalSheetIndexback to summary
public int getExternalSheetIndex(String workbookName, String sheetName)

gets the externSheet index for a sheet from an external workbook

Parameters
workbookName:String

e.g. "Budget.xls"

sheetName:String

a name of a sheet in that workbook

getNameback to summary
public EvaluationName getName(String name, int sheetIndex)

named range name matching is case insensitive

getNameXPtgback to summary
public Ptg getNameXPtg(String name, SheetIdentifier sheet)

Return an external name (named range, function, user-defined function) Ptg

getSpreadsheetVersionback to summary
public SpreadsheetVersion getSpreadsheetVersion()

Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)

getTableback to summary
public Table getTable(String name)

XSSF Only - gets a table that exists in the worksheet