Package org.apache.poi.ss.formula

Class SheetRangeEvaluator

java.lang.Object

org.apache.poi.ss.formula.SheetRangeEvaluator

All Implemented Interfaces:

SheetRange

public final class SheetRangeEvaluator
extends java.lang.Object
implements SheetRange

Evaluator for returning cells or sheets for a range of sheets

Constructor Summary

Constructors

Constructor	Description
SheetRangeEvaluator(int firstSheetIndex, int lastSheetIndex, org.apache.poi.ss.formula.SheetRefEvaluator[] sheetEvaluators)
SheetRangeEvaluator(int onlySheetIndex, org.apache.poi.ss.formula.SheetRefEvaluator sheetEvaluator)

Method Summary

Modifier and Type	Method	Description
int	adjustRowNumber(int rowIndex)	This method returns a lower row-number if it would lie outside the row-boundaries of any sheet.
java.lang.String	getBookName()
ValueEval	getEvalForCell(int sheetIndex, int rowIndex, int columnIndex)
int	getFirstSheetIndex()
int	getLastSheetIndex()
int	getSheetCount()
org.apache.poi.ss.formula.SheetRefEvaluator	getSheetEvaluator(int sheetIndex)
java.lang.String	getSheetName()
java.lang.String	getSheetName(int sheetIndex)
java.lang.String	getSheetNameRange()
SortedValues	getSortedColumnValue(int columnIndex, int firstRowIndex, int lastRowIndex)
boolean	isFiltered(int sheetIdx)
boolean	isHidden(int sheetIdx, int rowIndex, int columnIndex)
boolean	isRowHidden(int sheetIdx, int rowIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

SheetRangeEvaluator

public SheetRangeEvaluator(int firstSheetIndex,
                           int lastSheetIndex,
                           org.apache.poi.ss.formula.SheetRefEvaluator[] sheetEvaluators)

SheetRangeEvaluator

public SheetRangeEvaluator(int onlySheetIndex,
                           org.apache.poi.ss.formula.SheetRefEvaluator sheetEvaluator)

Method Detail

getSheetEvaluator

public org.apache.poi.ss.formula.SheetRefEvaluator getSheetEvaluator(int sheetIndex)

getFirstSheetIndex

public int getFirstSheetIndex()

Specified by:

getFirstSheetIndex in interface SheetRange

getLastSheetIndex

public int getLastSheetIndex()

Specified by:

getLastSheetIndex in interface SheetRange

getSheetName

public java.lang.String getSheetName(int sheetIndex)

getSheetNameRange

public java.lang.String getSheetNameRange()

getEvalForCell

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

adjustRowNumber

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 - The 0-based row-index to check

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.

getSheetCount

public int getSheetCount()

getSortedColumnValue

public SortedValues getSortedColumnValue(int columnIndex,
                                         int firstRowIndex,
                                         int lastRowIndex)

isHidden

public boolean isHidden(int sheetIdx,
                        int rowIndex,
                        int columnIndex)

isRowHidden

public boolean isRowHidden(int sheetIdx,
                           int rowIndex)

isFiltered

public boolean isFiltered(int sheetIdx)

getBookName

public java.lang.String getBookName()

getSheetName

public java.lang.String getSheetName()