org.apache.poi.hssf.record.formula.eval
Class Area3DEval

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.eval.Area3DEval
All Implemented Interfaces:
AreaEval, Eval, ValueEval

public class Area3DEval
extends java.lang.Object
implements AreaEval

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

Constructor Summary
Area3DEval(Ptg ptg, ValueEval[] values)
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Area3DEval

public Area3DEval(Ptg ptg,
                  ValueEval[] values)
Method Detail

getFirstColumn

public short getFirstColumn()
Description copied from interface: AreaEval
returns the 0-based index of the first col in this area.

Specified by:
getFirstColumn in interface AreaEval
Returns:

getFirstRow

public int getFirstRow()
Description copied from interface: AreaEval
returns the 0-based index of the first row in this area.

Specified by:
getFirstRow in interface AreaEval
Returns:

getLastColumn

public short getLastColumn()
Description copied from interface: AreaEval
returns the 0-based index of the last col in this area.

Specified by:
getLastColumn in interface AreaEval
Returns:

getLastRow

public int getLastRow()
Description copied from interface: AreaEval
returns the 0-based index of the last row in this area.

Specified by:
getLastRow in interface AreaEval
Returns:

getValues

public ValueEval[] getValues()
Description copied from interface: AreaEval
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.

Specified by:
getValues in interface AreaEval
Returns:

getValueAt

public ValueEval getValueAt(int row,
                            short col)
Description copied from interface: AreaEval
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.

Specified by:
getValueAt in interface AreaEval
Returns:

contains

public boolean contains(int row,
                        short col)
Description copied from interface: AreaEval
returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.

Specified by:
contains in interface AreaEval
Returns:

containsRow

public boolean containsRow(int row)
Description copied from interface: AreaEval
returns true if the specified row is in range

Specified by:
containsRow in interface AreaEval
Returns:

containsColumn

public boolean containsColumn(short col)
Description copied from interface: AreaEval
returns true if the specified col is in range

Specified by:
containsColumn in interface AreaEval
Returns:

isColumn

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

Specified by:
isColumn in interface AreaEval
Returns:

isRow

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

Specified by:
isRow in interface AreaEval
Returns:


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