Class AreaEvalBase

    • 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
      • 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.
      • 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)
      • 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'