Package io.keikai.range.formula

Interface AreaEval

All Superinterfaces:
TwoDEval, ValueEval
public interface AreaEval extends TwoDEval
Reference to a rectangular area of cells. Combines the absolute grid coordinates (getFirstRow(), getFirstColumn(), …) with a TwoDEval-style relative-coordinate accessor.

Replaces org.apache.poi.ss.formula.eval.AreaEval.

Since:
7.0.0

  • Method Details

    • getFirstRow

      int getFirstRow()
      Returns:
      inclusive 0-based starting row.

    • getFirstColumn

      int getFirstColumn()
      Returns:
      inclusive 0-based starting column.

    • getLastRow

      int getLastRow()
      Returns:
      inclusive 0-based ending row.

    • getLastColumn

      int getLastColumn()
      Returns:
      inclusive 0-based ending column.

    • getFirstSheetIndex

      int getFirstSheetIndex()
      Returns:
      inclusive starting sheet index.

    • getLastSheetIndex

      int getLastSheetIndex()
      Returns:
      inclusive ending sheet index.

    • getAbsoluteValue

      ValueEval getAbsoluteValue(int row, int col)
      Cell value at absolute row/column coordinates within the sheet.
      Throws:
      IllegalArgumentException - if the coordinates are outside this area

    • getRelativeValue

      ValueEval getRelativeValue(int relativeRowIndex, int relativeColumnIndex)
      Cell value at coordinates relative to the area's top-left. Equivalent to TwoDEval.getValue(int, int).

    • isRow

      boolean isRow()
      Specified by:
      isRow in interface TwoDEval
      Returns:
      true if this area collapses to a single row.

    • isColumn

      boolean isColumn()
      Specified by:
      isColumn in interface TwoDEval
      Returns:
      true if this area collapses to a single column.