Package org.apache.poi.ss.formula

Class LazyAreaEval

java.lang.Object

org.apache.poi.ss.formula.eval.AreaEvalBase

org.apache.poi.ss.formula.LazyAreaEval

All Implemented Interfaces:

AreaEval, HyperlinkEval, ValueEval, SheetRange, ThreeDEval, TwoDEval

public final class LazyAreaEval
extends AreaEvalBase
implements HyperlinkEval

Provides Lazy Evaluation to 3D Ranges

Constructor Summary

Constructors

Constructor	Description
LazyAreaEval(int firstRowIndex, int firstColumnIndex, int lastRowIndex, int lastColumnIndex, boolean firstRowRel, boolean firstColRel, boolean lastRowRel, boolean lastColRel, SheetRangeEvaluator evaluator)

Method Summary

Modifier and Type	Method	Description
String	getBookName()
LazyAreaEval	getColumn(int columnIndex)
int	getDepth()
Hyperlink	getHyperlink()	Returns the associated hyperlink if this ValueEval is a label of the HYPERLINK function.
String	getLastSheetName()
SheetRangeEvaluator	getRefEvaluator()
ValueEval	getRelativeValue(int relativeRowIndex, int relativeColumnIndex)
ValueEval	getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)
LazyAreaEval	getRow(int rowIndex)
String	getSheetName()
boolean	isFiltered()
boolean	isHidden(int rowIndex, int columnIndex)
boolean	isRowHidden(int rowIndex)
boolean	isSubTotal(int rowIndex, int columnIndex)
AreaEval	offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx)	Creates an AreaEval offset by a relative amount from the upper left cell of this area
void	setHyperlink(Hyperlink hyperlink)	Sets the associated hyperlink if this ValueEval is a label of the HYPERLINK function.
String	toString()

Methods inherited from class org.apache.poi.ss.formula.eval.AreaEvalBase

contains, containsColumn, containsRow, getAbsoluteValue, getFirstColumn, getFirstRow, getFirstSheetIndex, getHeight, getLastColumn, getLastRow, getLastSheetIndex, getValue, getValue, getWidth, isColumn, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, isRow

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyAreaEval

public LazyAreaEval(int firstRowIndex,
                    int firstColumnIndex,
                    int lastRowIndex,
                    int lastColumnIndex,
                    boolean firstRowRel,
                    boolean firstColRel,
                    boolean lastRowRel,
                    boolean lastColRel,
                    SheetRangeEvaluator evaluator)

Method Detail

getRelativeValue

public ValueEval getRelativeValue(int relativeRowIndex,
                                  int relativeColumnIndex)

Specified by:

getRelativeValue in interface AreaEval

Specified by:

getRelativeValue in class AreaEvalBase

Returns:

the ValueEval from within this area at the specified relativeRowIndex and relativeColumnIndex. Never null (possibly BlankEval). The specified indexes should relative to the top left corner of this area.

getRelativeValue

public ValueEval getRelativeValue(int sheetIndex,
                                  int relativeRowIndex,
                                  int relativeColumnIndex)

Specified by:

getRelativeValue in class AreaEvalBase

offset

public AreaEval offset(int relFirstRowIx,
                       int relLastRowIx,
                       int relFirstColIx,
                       int relLastColIx)

Description copied from interface: AreaEval

Creates an AreaEval offset by a relative amount from the upper left cell of this area

Specified by:

offset in interface AreaEval

getRow

public LazyAreaEval getRow(int rowIndex)

Specified by:

getRow in interface TwoDEval

Parameters:

rowIndex - relative row index (zero based)

Returns:

a single row TwoDEval

getColumn

public LazyAreaEval getColumn(int columnIndex)

Specified by:

getColumn in interface TwoDEval

Parameters:

columnIndex - relative column index (zero based)

Returns:

a single column TwoDEval

toString

public String toString()

Overrides:

toString in class Object

isSubTotal

public boolean isSubTotal(int rowIndex,
                          int columnIndex)

Specified by:

isSubTotal in interface TwoDEval

Overrides:

isSubTotal in class AreaEvalBase

Returns:

whether cell at rowIndex and columnIndex is a subtotal

setHyperlink

public void setHyperlink(Hyperlink hyperlink)

Description copied from interface: HyperlinkEval

Sets the associated hyperlink if this ValueEval is a label of the HYPERLINK function.

Specified by:

setHyperlink in interface HyperlinkEval

Parameters:

hyperlink - the associated hyperlink

getHyperlink

public Hyperlink getHyperlink()

Description copied from interface: HyperlinkEval

Returns the associated hyperlink if this ValueEval is a label of the HYPERLINK function.

Specified by:

getHyperlink in interface HyperlinkEval

Returns:

the associated hyperlink.

getDepth

public int getDepth()

isHidden

public boolean isHidden(int rowIndex,
                        int columnIndex)

Specified by:

isHidden in interface TwoDEval

Returns:

true if the cell at row and col is hidden

isRowHidden

public boolean isRowHidden(int rowIndex)

Specified by:

isRowHidden in interface TwoDEval

Overrides:

isRowHidden in class AreaEvalBase

Returns:

whether the row at rowIndex is hidden

See Also:

TwoDEval.isRowHidden(int)

isFiltered

public boolean isFiltered()

Specified by:

isFiltered in interface TwoDEval

Returns:

true if the sheet of the area exists any auto filter or table filter which is applied.

See Also:

Subtotal

getRefEvaluator

public SheetRangeEvaluator getRefEvaluator()

getBookName

public String getBookName()

getSheetName

public String getSheetName()

getLastSheetName

public String getLastSheetName()