org.apache.poi.hssf.record.formula.eval
Interface AreaEval

All Superinterfaces:
Eval, ValueEval
All Known Implementing Classes:
Area2DEval, Area3DEval

public interface AreaEval
extends ValueEval

Author:
Amol S. Deshmukh < amolweb at ya hoo dot com >

Method Summary
 boolean contains(int row, short col)
          returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.
 boolean containsColumn(short col)
          returns true if the specified col is in range
 boolean containsRow(int row)
          returns true if the specified row is in range
 short getFirstColumn()
          returns the 0-based index of the first col in this area.
 int getFirstRow()
          returns the 0-based index of the first row in this area.
 short getLastColumn()
          returns the 0-based index of the last col in this area.
 int getLastRow()
          returns the 0-based index of the last row in this area.
 ValueEval getValueAt(int row, short col)
          returns the ValueEval from the values array at the specified row and col index.
 ValueEval[] getValues()
          The array of values in this area.
 boolean isColumn()
          returns true if the Area's start and end col indexes are same.
 boolean isRow()
          returns true if the Area's start and end row indexes are same.
 

Method Detail

getFirstRow

int getFirstRow()
returns the 0-based index of the first row in this area.


getLastRow

int getLastRow()
returns the 0-based index of the last row in this area.


getFirstColumn

short getFirstColumn()
returns the 0-based index of the first col in this area.


getLastColumn

short getLastColumn()
returns the 0-based index of the last col in this area.


isRow

boolean isRow()
returns true if the Area's start and end row indexes are same. This result of this method should agree with getFirstRow() == getLastRow().


isColumn

boolean isColumn()
returns true if the Area's start and end col indexes are same. This result of this method should agree with getFirstColumn() == getLastColumn().


getValues

ValueEval[] getValues()
The array of values in this area. Although the area maybe 1D (ie. isRow() or isColumn() returns true) or 2D the returned array is 1D.


getValueAt

ValueEval getValueAt(int row,
                     short col)
returns the ValueEval from the values array at the specified row and col index. The specified indexes should be absolute indexes in the sheet and not relative indexes within the area. Also, if contains(row, col) evaluates to true, a null value will bre returned.

Parameters:
row -
col -

contains

boolean contains(int row,
                 short col)
returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.

Parameters:
row -
col -

containsColumn

boolean containsColumn(short col)
returns true if the specified col is in range

Parameters:
col -

containsRow

boolean containsRow(int row)
returns true if the specified row is in range

Parameters:
row -


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.