Modifier and Type	Class and Description
public static class	EvaluationWorkbook.ExternalName
public static class	EvaluationWorkbook.ExternalSheet
public static class	EvaluationWorkbook.ExternalSheetRange

Method Summary

Modifier and Type	Method and Description
public void	clearAllCachedResultValues() Propagated from `WorkbookEvaluator#clearAllCachedResultValues()` to clear locally cached data.
public int	convertFromExternSheetIndex(int externSheetIndex) HSSF Only - convert an external sheet index to an internal sheet index, for an external-style reference to one of this workbook's own sheets
public EvaluationWorkbook.ExternalName	getExternalName(int externSheetIndex, int externNameIndex) HSSF Only - fetch the external-style name details
public EvaluationWorkbook.ExternalName	getExternalName(String nameName, String sheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style name details
public EvaluationWorkbook.ExternalSheet	Returns: The found sheet or null if not found getExternalSheet(int externSheetIndex) HSSF Only - fetch the external-style sheet details Return will have no workbook set if it's actually in our own workbook
public EvaluationWorkbook.ExternalSheet	Returns: The found sheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style sheet details Return will have no workbook set if it's actually in our own workbook
public Ptg[]	getFormulaTokens(EvaluationCell cell)
public EvaluationName	getName(NamePtg namePtg)
public EvaluationName	getName(String name, int sheetIndex)
public EvaluationSheet	Returns: The sheet getSheet(int The 0-based index of the sheet sheetIndex) Get the sheet identified by the given 0-based index.
public int	Returns: -1 if the specified sheet is from a different book getSheetIndex(EvaluationSheet sheet)
public int	Returns: the index of the sheet matching the specified name. -1 if not found getSheetIndex(String sheetName) Finds a sheet index by case insensitive name.
public String	Returns: The name of the sheet getSheetName(int The 0-based index of the sheet sheetIndex) Returns the name of the sheet at the given 0-based index.
public SpreadsheetVersion	getSpreadsheetVersion()
public UDFFinder	getUDFFinder()
public String	resolveNameXText(NameXPtg ptg)

Method Detail

clearAllCachedResultValues back to summary

clearAllCachedResultValues	back to summary
public void clearAllCachedResultValues() Propagated from `WorkbookEvaluator#clearAllCachedResultValues()` to clear locally cached data. Implementations must call the same method on all referenced `EvaluationSheet` instances, as well as clearing local caches. Since POI 3.15 beta 3 See Also `WorkbookEvaluator#clearAllCachedResultValues()`

public void clearAllCachedResultValues()

Propagated from WorkbookEvaluator#clearAllCachedResultValues() to clear locally cached data. Implementations must call the same method on all referenced EvaluationSheet instances, as well as clearing local caches.

Since: POI 3.15 beta 3
See Also: WorkbookEvaluator#clearAllCachedResultValues()

convertFromExternSheetIndex	back to summary
public int convertFromExternSheetIndex(int externSheetIndex) HSSF Only - convert an external sheet index to an internal sheet index, for an external-style reference to one of this workbook's own sheets

getExternalName	back to summary
public EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex, int externNameIndex) HSSF Only - fetch the external-style name details

getExternalName	back to summary
public EvaluationWorkbook.ExternalName getExternalName(String nameName, String sheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style name details

getExternalSheet	back to summary
public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex) HSSF Only - fetch the external-style sheet details Return will have no workbook set if it's actually in our own workbook Returns:EvaluationWorkbook.ExternalSheet The found sheet or null if not found Exceptions IllegalStateException: If called with XSSF or SXSSF workbooks

getExternalSheet

back to summary

public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

HSSF Only - fetch the external-style sheet details

Return will have no workbook set if it's actually in our own workbook

Returns:EvaluationWorkbook.ExternalSheet

The found sheet or null if not found

Exceptions

IllegalStateException:: If called with XSSF or SXSSF workbooks

getExternalSheet	back to summary
public EvaluationWorkbook.ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber) XSSF Only - fetch the external-style sheet details Return will have no workbook set if it's actually in our own workbook Returns:EvaluationWorkbook.ExternalSheet The found sheet Exceptions IllegalStateException: If called with HSSF workbooks

getExternalSheet

back to summary

public EvaluationWorkbook.ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber)

XSSF Only - fetch the external-style sheet details

Return will have no workbook set if it's actually in our own workbook

Returns:EvaluationWorkbook.ExternalSheet

The found sheet

Exceptions

IllegalStateException:: If called with HSSF workbooks

getFormulaTokens	back to summary
public Ptg[] getFormulaTokens(EvaluationCell cell)

getName	back to summary
public EvaluationName getName(NamePtg namePtg)

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

getSheet	back to summary
public EvaluationSheet getSheet(int sheetIndex) Get the sheet identified by the given 0-based index. Parameters sheetIndex:int The 0-based index of the sheet Returns:EvaluationSheet The sheet Exceptions IllegalArgumentException: If the index is outside the indices of available sheets

getSheet

back to summary

public EvaluationSheet getSheet(int sheetIndex)

Get the sheet identified by the given 0-based index.

Parameters

sheetIndex:int: The 0-based index of the sheet

Returns:EvaluationSheet

The sheet

Exceptions

IllegalArgumentException:: If the index is outside the indices of available sheets

getSheetIndex	back to summary
public int getSheetIndex(EvaluationSheet sheet) Returns:int -1 if the specified sheet is from a different book

getSheetIndex	back to summary
public int getSheetIndex(String sheetName) Finds a sheet index by case insensitive name. Returns:int the index of the sheet matching the specified name. -1 if not found

getSheetIndex

back to summary

public int getSheetIndex(String sheetName)

Finds a sheet index by case insensitive name.

Returns:int: the index of the sheet matching the specified name. -1 if not found

getSheetName	back to summary
public String getSheetName(int sheetIndex) Returns the name of the sheet at the given 0-based index. Parameters sheetIndex:int The 0-based index of the sheet Returns:String The name of the sheet Exceptions IllegalArgumentException: If the index is outside the indices of available sheets

getSheetName

back to summary

public String getSheetName(int sheetIndex)

Returns the name of the sheet at the given 0-based index.

Parameters

sheetIndex:int: The 0-based index of the sheet

Returns:String

The name of the sheet

Exceptions

IllegalArgumentException:: If the index is outside the indices of available sheets

getSpreadsheetVersion	back to summary
public SpreadsheetVersion getSpreadsheetVersion()

getUDFFinder	back to summary
public UDFFinder getUDFFinder()

resolveNameXText	back to summary
public String resolveNameXText(NameXPtg ptg)

org.apache.poi.ss.formula back to summary

public Class EvaluationWorkbook.ExternalName

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName

Field Summary

Modifier and Type	Field and Description
private final int	_ix
private final String	_nameName
private final int	_nameNumber

Constructor Summary

Access	Constructor and Description
public	ExternalName(String nameName, int nameNumber, int ix)

Method Summary

Modifier and Type	Method and Description
public int	getIx()
public String	getName()
public int	getNumber()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_ix	back to summary
private final int _ix

_nameName	back to summary
private final String _nameName

_nameNumber	back to summary
private final int _nameNumber

Constructor Detail

ExternalName	back to summary
public ExternalName(String nameName, int nameNumber, int ix)

Method Detail

getIx	back to summary
public int getIx()

getName	back to summary
public String getName()

getNumber	back to summary
public int getNumber()

org.apache.poi.ss.formula back to summary

public Class EvaluationWorkbook.ExternalSheet

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet

Known Direct Subclasses

org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheetRange

Field Summary

Modifier and Type	Field and Description
private final String	_sheetName
private final String	_workbookName

Constructor Summary

Access	Constructor and Description
public	ExternalSheet(String workbookName, String sheetName)

Method Summary

Modifier and Type	Method and Description
public String	getSheetName()
public String	getWorkbookName()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_sheetName	back to summary
private final String _sheetName

_workbookName	back to summary
private final String _workbookName

Constructor Detail

ExternalSheet	back to summary
public ExternalSheet(String workbookName, String sheetName)

Method Detail

getSheetName	back to summary
public String getSheetName()

getWorkbookName	back to summary
public String getWorkbookName()

org.apache.poi.ss.formula back to summary

public Class EvaluationWorkbook.ExternalSheetRange

Class Inheritance

extends ExternalSheet

java.lang.Object
org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet
org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheetRange

Field Summary

Modifier and Type	Field and Description
private final String	_lastSheetName

Constructor Summary

Access	Constructor and Description
public	ExternalSheetRange(String workbookName, String firstSheetName, String lastSheetName)

Method Summary

Modifier and Type	Method and Description
public String	getFirstSheetName()
public String	getLastSheetName()

Inherited from org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet:: getSheetName getWorkbookName

Field Detail

_lastSheetName	back to summary
private final String _lastSheetName

Constructor Detail

ExternalSheetRange	back to summary
public ExternalSheetRange(String workbookName, String firstSheetName, String lastSheetName)

Method Detail

getFirstSheetName	back to summary
public String getFirstSheetName()

getLastSheetName	back to summary
public String getLastSheetName()

public Interface EvaluationWorkbook

Nested and Inner Type Summary

Method Summary

Method Detail

public Class EvaluationWorkbook.ExternalName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class EvaluationWorkbook.ExternalSheet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class EvaluationWorkbook.ExternalSheetRange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail