Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

    java.lang.Object
      org.apache.poi.ss.formula.eval.AreaEvalBase

All Implemented Interfaces:
  AreaEval, ValueEval, SheetRange, ThreeDEval, TwoDEval

    public abstract class AreaEvalBase

extends java.lang.Object
implements AreaEval

Author:
  Josh Micich

Constructor Summary
`protected` | `AreaEvalBase(AreaI ptg)`
`protected` | `AreaEvalBase(AreaI ptg, SheetRange sheets)`
`protected` | `AreaEvalBase(int firstRow, int firstColumn, int lastRow, int lastColumn)`
`protected` | `AreaEvalBase(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn)`

Method Summary
`boolean` | `contains(int row, int col)` returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.
`boolean` | `containsColumn(int col)` returns true if the specified col is in range
`boolean` | `containsRow(int row)` returns true if the specified row is in range
`ValueEval` | `getAbsoluteValue(int row, int col)`
`int` | `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.
`int` | `getFirstSheetIndex()`
`int` | `getHeight()`
`int` | `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.
`int` | `getLastSheetIndex()`
`abstract ValueEval` | `getRelativeValue(int relativeRowIndex, int relativeColumnIndex)`
`abstract ValueEval` | `getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)`
`ValueEval` | `getValue(int row, int col)`
`ValueEval` | `getValue(int sheetIndex, int row, int col)`
`int` | `getWidth()`
`boolean` | `isColumn()`
`boolean` | `isRow()`
`boolean` | `isSubTotal(int rowIndex, int columnIndex)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.poi.ss.formula.eval.AreaEval
`offset`

Methods inherited from interface org.apache.poi.ss.formula.TwoDEval
`getColumn, getRow`

Constructor Detail

### AreaEvalBase

    protected AreaEvalBase(SheetRange sheets,
                           int firstRow,
                           int firstColumn,
                           int lastRow,
                           int lastColumn)

### AreaEvalBase

    protected AreaEvalBase(int firstRow,
                           int firstColumn,
                           int lastRow,
                           int lastColumn)

### AreaEvalBase

    protected AreaEvalBase(AreaI ptg)

### AreaEvalBase

    protected AreaEvalBase(AreaI ptg,
                           SheetRange sheets)

Method Detail

### getFirstColumn

    public final int getFirstColumn()

  Description copied from interface: `AreaEval`
  returns the 0-based index of the first col in this area.

  Specified by:
    `getFirstColumn` in interface `AreaEval`

### getFirstRow

    public final 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`

### getLastColumn

    public final int getLastColumn()

  Description copied from interface: `AreaEval`
  returns the 0-based index of the last col in this area.

  Specified by:
    `getLastColumn` in interface `AreaEval`

### getLastRow

    public final 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`

### getFirstSheetIndex

    public int getFirstSheetIndex()

  Specified by:
    `getFirstSheetIndex` in interface `SheetRange`

### getLastSheetIndex

    public int getLastSheetIndex()

  Specified by:
    `getLastSheetIndex` in interface `SheetRange`

### getAbsoluteValue

    public final ValueEval getAbsoluteValue(int row,
                                            int col)

  Specified by:
    `getAbsoluteValue` in interface `AreaEval`
  Returns:
    the ValueEval from within this area at the specified row and col index. Never `null` (possibly `BlankEval`). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.

### contains

    public final boolean contains(int row,
                                  int 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`

### containsRow

    public final boolean containsRow(int row)

  Description copied from interface: `AreaEval`
  returns true if the specified row is in range

  Specified by:
    `containsRow` in interface `AreaEval`

### containsColumn

    public final boolean containsColumn(int col)

  Description copied from interface: `AreaEval`
  returns true if the specified col is in range

  Specified by:
    `containsColumn` in interface `AreaEval`

### isColumn

    public final boolean isColumn()

  Specified by:
    `isColumn` in interface `TwoDEval`
  Returns:
    `true` if the area has just a single column, this also includes the trivial case when the area has just a single cell.

### isRow

    public final boolean isRow()

  Specified by:
    `isRow` in interface `TwoDEval`
  Returns:
    `true` if the area has just a single row, this also includes the trivial case when the area has just a single cell.

### getHeight

    public int getHeight()

  Specified by:
    `getHeight` in interface `AreaEval`
  Specified by:
    `getHeight` in interface `TwoDEval`

### getValue

    public final ValueEval getValue(int row,
                                    int col)

  Specified by:
    `getValue` in interface `TwoDEval`
  Parameters:
    `row` - relative row index (zero based)
    `col` - relative column index (zero based)
  Returns:
    element at the specified row and column position

### getValue

    public final ValueEval getValue(int sheetIndex,
                                    int row,
                                    int col)

  Specified by:
    `getValue` in interface `ThreeDEval`
  Parameters:
    `sheetIndex` - sheet index (zero based)
    `row` - relative row index (zero based)
    `col` - relative column index (zero based)
  Returns:
    element at the specified row and column position

### getRelativeValue

    public abstract ValueEval getRelativeValue(int relativeRowIndex,
                                               int relativeColumnIndex)

  Specified by:
    `getRelativeValue` in interface `AreaEval`
  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 abstract ValueEval getRelativeValue(int sheetIndex,
                                               int relativeRowIndex,
                                               int relativeColumnIndex)

### getWidth

    public int getWidth()

  Specified by:
    `getWidth` in interface `AreaEval`
  Specified by:
    `getWidth` in interface `TwoDEval`

### isSubTotal

    public boolean isSubTotal(int rowIndex,
                              int columnIndex)

  Specified by:
    `isSubTotal` in interface `TwoDEval`
  Returns:
    whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals'

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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