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

pack-priv final Class SheetRangeEvaluator

extends Object
implements SheetRange
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.SheetRange
Imports
org.apache.poi.ss.formula.eval.ValueEval

Evaluator for returning cells or sheets for a range of sheets

Field Summary

Modifier and TypeField and Description
private final int
private final int
private final SheetRefEvaluator[]

Constructor Summary

AccessConstructor and Description
public
SheetRangeEvaluator(int firstSheetIndex, int lastSheetIndex, SheetRefEvaluator[] sheetEvaluators)

public
SheetRangeEvaluator(int onlySheetIndex, SheetRefEvaluator sheetEvaluator)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

If the given index lies withing the max row number across all sheets, it is returned. Otherwise, the highest used row number across all sheets is returned.
adjustRowNumber
(int
The 0-based row-index to check
rowIndex
)

This method returns a lower row-number if it would lie outside the row-boundaries of any sheet.

public ValueEval
getEvalForCell(int sheetIndex, int rowIndex, int columnIndex)

public int
public int
public SheetRefEvaluator
getSheetEvaluator(int sheetIndex)

public String
getSheetName(int sheetIndex)

public String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_firstSheetIndexback to summary
private final int _firstSheetIndex
_lastSheetIndexback to summary
private final int _lastSheetIndex
_sheetEvaluatorsback to summary
private final SheetRefEvaluator[] _sheetEvaluators

Constructor Detail

SheetRangeEvaluatorback to summary
public SheetRangeEvaluator(int firstSheetIndex, int lastSheetIndex, SheetRefEvaluator[] sheetEvaluators)
SheetRangeEvaluatorback to summary
public SheetRangeEvaluator(int onlySheetIndex, SheetRefEvaluator sheetEvaluator)

Method Detail

adjustRowNumberback to summary
public int adjustRowNumber(int rowIndex)

This method returns a lower row-number if it would lie outside the row-boundaries of any sheet. This is used to optimize cases where very high number of rows would be checked otherwise without any benefit as no such row exists anyway.

Parameters
rowIndex:int

The 0-based row-index to check

Returns:int

If the given index lies withing the max row number across all sheets, it is returned. Otherwise, the highest used row number across all sheets is returned.

getEvalForCellback to summary
public ValueEval getEvalForCell(int sheetIndex, int rowIndex, int columnIndex)
getFirstSheetIndexback to summary
public int getFirstSheetIndex()

Implements org.apache.poi.ss.formula.SheetRange.getFirstSheetIndex.

getLastSheetIndexback to summary
public int getLastSheetIndex()

Implements org.apache.poi.ss.formula.SheetRange.getLastSheetIndex.

getSheetEvaluatorback to summary
public SheetRefEvaluator getSheetEvaluator(int sheetIndex)
getSheetNameback to summary
public String getSheetName(int sheetIndex)
getSheetNameRangeback to summary
public String getSheetNameRange()