Top Description Fields Constructors Methods
org.apache.poi.ss.formula.eval.forked

pack-priv final Class ForkedEvaluationWorkbook

extends Object
implements EvaluationWorkbook
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.EvaluationWorkbook
Annotations
@Internal
Imports
java.util.HashMap, .Map, org.apache.poi.ss.SpreadsheetVersion, org.apache.poi.ss.formula.EvaluationCell, .EvaluationName, .EvaluationSheet, .EvaluationWorkbook, org.apache.poi.ss.formula.ptg.NamePtg, .NameXPtg, .Ptg, org.apache.poi.ss.formula.udf.UDFFinder, org.apache.poi.ss.usermodel.Workbook, org.apache.poi.util.Internal
Represents a workbook being used for forked evaluation. Most operations are delegated to the shared master workbook, except those that potentially involve cell values that may have been updated after a call to getOrCreateUpdatableCell(String, int, int).
For POI internal use only

Field Summary

Modifier and TypeField and Description
private final EvaluationWorkbook
_masterBook

private final Map<String, ForkedEvaluationSheet>
_sharedSheetsByName

Constructor Summary

AccessConstructor and Description
public
ForkedEvaluationWorkbook(EvaluationWorkbook master)

Method Summary

Modifier and TypeMethod and Description
public void
clearAllCachedResultValues()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.clearAllCachedResultValues.

Propagated from WorkbookEvaluator#clearAllCachedResultValues() to clear locally cached data.

public int
convertFromExternSheetIndex(int externSheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.convertFromExternSheetIndex.

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 void
copyUpdatedCells(Workbook workbook)

public EvaluationCell
getEvaluationCell(String sheetName, int rowIndex, int columnIndex)

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

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

HSSF Only - fetch the external-style name details

public EvaluationWorkbook.ExternalName
getExternalName(String nameName, String sheetName, int externalWorkbookNumber)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

XSSF Only - fetch the external-style name details

public EvaluationWorkbook.ExternalSheet
getExternalSheet(int externSheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

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
getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

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)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getFormulaTokens.

public EvaluationName
getName(NamePtg namePtg)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getName.

public EvaluationName
getName(String name, int sheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getName.

public ForkedEvaluationCell
getOrCreateUpdatableCell(String sheetName, int rowIndex, int columnIndex)

private ForkedEvaluationSheet
getSharedSheet(String sheetName)

public EvaluationSheet
getSheet(int
The 0-based index of the sheet
sheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheet.

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

public int
getSheetIndex(EvaluationSheet sheet)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

public int
getSheetIndex(String sheetName)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

Finds a sheet index by case insensitive name.

public String
getSheetName(int
The 0-based index of the sheet
sheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetName.

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

public SpreadsheetVersion
getSpreadsheetVersion()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSpreadsheetVersion.

public UDFFinder
getUDFFinder()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getUDFFinder.

public String
resolveNameXText(NameXPtg ptg)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.resolveNameXText.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_masterBookback to summary
private final EvaluationWorkbook _masterBook
_sharedSheetsByNameback to summary
private final Map<String, ForkedEvaluationSheet> _sharedSheetsByName

Constructor Detail

ForkedEvaluationWorkbookback to summary
public ForkedEvaluationWorkbook(EvaluationWorkbook master)

Method Detail

clearAllCachedResultValuesback to summary
public void clearAllCachedResultValues()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.clearAllCachedResultValues.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.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.

Annotations
@Override
convertFromExternSheetIndexback to summary
public int convertFromExternSheetIndex(int externSheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.convertFromExternSheetIndex.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.convertFromExternSheetIndex.

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

Annotations
@Override
copyUpdatedCellsback to summary
public void copyUpdatedCells(Workbook workbook)
getEvaluationCellback to summary
public EvaluationCell getEvaluationCell(String sheetName, int rowIndex, int columnIndex)
getExternalNameback to summary
public EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex, int externNameIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

HSSF Only - fetch the external-style name details

Annotations
@Override
getExternalNameback to summary
public EvaluationWorkbook.ExternalName getExternalName(String nameName, String sheetName, int externalWorkbookNumber)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getExternalName.

XSSF Only - fetch the external-style name details

Annotations
@Override
getExternalSheetback to summary
public EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

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

Annotations
@Override
getExternalSheetback to summary
public EvaluationWorkbook.ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getExternalSheet.

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

Annotations
@Override
getFormulaTokensback to summary
public Ptg[] getFormulaTokens(EvaluationCell cell)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getFormulaTokens.

Annotations
@Override
getNameback to summary
public EvaluationName getName(NamePtg namePtg)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getName.

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

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getName.

Annotations
@Override
getOrCreateUpdatableCellback to summary
public ForkedEvaluationCell getOrCreateUpdatableCell(String sheetName, int rowIndex, int columnIndex)
getSharedSheetback to summary
private ForkedEvaluationSheet getSharedSheet(String sheetName)
getSheetback to summary
public EvaluationSheet getSheet(int sheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheet.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getSheet.

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

Parameters
sheetIndex:int

The 0-based index of the sheet

Returns:EvaluationSheet

The sheet

Annotations
@Override
getSheetIndexback to summary
public int getSheetIndex(EvaluationSheet sheet)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

Returns:int

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

-1 if the specified sheet is from a different book

Annotations
@Override
getSheetIndexback to summary
public int getSheetIndex(String sheetName)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getSheetIndex.

Finds a sheet index by case insensitive name.

Returns:int

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

Annotations
@Override
getSheetNameback to summary
public String getSheetName(int sheetIndex)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSheetName.

Doc from org.apache.poi.ss.formula.EvaluationWorkbook.getSheetName.

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

Annotations
@Override
getSpreadsheetVersionback to summary
public SpreadsheetVersion getSpreadsheetVersion()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getSpreadsheetVersion.

Annotations
@Override
getUDFFinderback to summary
public UDFFinder getUDFFinder()

Implements org.apache.poi.ss.formula.EvaluationWorkbook.getUDFFinder.

Annotations
@Override
resolveNameXTextback to summary
public String resolveNameXText(NameXPtg ptg)

Implements org.apache.poi.ss.formula.EvaluationWorkbook.resolveNameXText.

Annotations
@Override