Range

```
public interface Range
```
The representation of a cell (or cells) on your csv sheet.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Range`	`activate()` Make this range the active range.
`Range`	`clear()` Clears the range of contents, formats, and data-validation rules.
`void`	`copyTo(Range destination)` Copies the data from a range of cells to another range of cells.
`void`	`forEach(CellVisitor callback)` Executes a provided function for each cell in the range
`Range`	`getCell(int row, int column)` Returns a given cell within a range.
`int`	`getColumn()` Returns the starting column position for this range.
`int`	`getLastColumn()` Returns the end column position.
`int`	`getLastRow()` Returns the end row position.
`int`	`getNumColumns()` Returns the number of columns in this range.
`int`	`getNumRows()` Returns the number of rows in this range.
`int`	`getRow()` Returns the starting row position for this range.
`CsvSheet`	`getSheet()` Returns the sheet this range belongs to.
`java.lang.Object`	`getValue()` Returns the value of the top-left cell in the range.
`java.lang.Object[][]`	`getValues()` Returns the rectangular sheet of values for this range.
`boolean`	`isBlank()` Returns true if the range is totally empty.
`void`	`moveTo(Range destination)` Cut and paste the data from this range to the target range.
`Range`	`offset(int rowOffset, int columnOffset)` Returns a new range that is offset from this range by the given number of rows and columns (which can be negative).
`Range`	`offset(int rowOffset, int columnOffset, int numRows, int numColumns)` Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height and width in cells.
`Range`	`setValue(java.lang.Object value)` Sets the value of the range.
`Range`	`setValues(java.lang.Object[][] values)` Sets a rectangular sheet of values (must match dimensions of this range).
`Range`	`sort(java.lang.Object sortSpecObj)` Sorts the cells in a given range, by column and order specified.

- Method Detail
  - activate
```
Range activate()
```
    Make this range the active range.
    
    Returns:
    
    the range for chaining
  - clear
```
Range clear()
```
    Clears the range of contents, formats, and data-validation rules.
    
    Returns:
    
    the range for chaining
  - getCell
```
Range getCell(int row,
              int column)
```
    Returns a given cell within a range.
    
    Parameters:
    
    row - the row of the cell relative to the range
    
    column - the column of the cell relative to the range
    
    Returns:
    
    a range containing a single cell at the specified coordinates
  - getRow
```
int getRow()
```
    Returns the starting row position for this range.
    
    Returns:
    
    the range's starting row position in the sheet
  - getColumn
```
int getColumn()
```
    Returns the starting column position for this range.
    
    Returns:
    
    the range's starting column position in the sheet
  - getLastRow
```
int getLastRow()
```
    Returns the end row position.
    
    Returns:
    
    the range's ending row position in the sheet
  - getLastColumn
```
int getLastColumn()
```
    Returns the end column position.
    
    Returns:
    
    the range's ending column position in the sheet
  - getNumRows
```
int getNumRows()
```
    Returns the number of rows in this range.
    
    Returns:
    
    the number of rows in this range
  - getNumColumns
```
int getNumColumns()
```
    Returns the number of columns in this range.
    
    Returns:
    
    the number of columns in this range
  - getSheet
```
CsvSheet getSheet()
```
    Returns the sheet this range belongs to.
    
    Returns:
    
    the sheet that this range belongs to
  - getValue
```
java.lang.Object getValue()
```
    Returns the value of the top-left cell in the range.
    
    Returns:
    
    the value in this cell
  - getValues
```
java.lang.Object[][] getValues()
```
    Returns the rectangular sheet of values for this range. Returns a two-dimensional array of values, indexed by row, then by column.
    
    Returns:
    
    a two-dimensional array of values
  - isBlank
```
boolean isBlank()
```
    Returns true if the range is totally empty.
    
    Returns:
    
    whether the range is blank or not
  - copyTo
```
void copyTo(Range destination)
```
    Copies the data from a range of cells to another range of cells.
    
    Parameters:
    
    destination - a destination range to copy to; only the top-left cell position is relevant
  - moveTo
```
void moveTo(Range destination)
```
    Cut and paste the data from this range to the target range.
    
    Parameters:
    
    destination - a destination range to copy to; only the top-left cell position is relevant
  - offset
```
Range offset(int rowOffset,
             int columnOffset)
```
    Returns a new range that is offset from this range by the given number of rows and columns (which can be negative). The new range will be the same size as the original range.
    
    Parameters:
    
    rowOffset - number of rows down from the range's top-left cell; negative values represent rows up from the range's top-left cell
    
    columnOffset - number of columns right from the range's top-left cell; negative values represent columns left from the range's top-left cell
    
    Returns:
    
    the range for chaining
  - offset
```
Range offset(int rowOffset,
             int columnOffset,
             int numRows,
             int numColumns)
```
    Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height and width in cells.
    
    Parameters:
    
    rowOffset - number of rows down from the range's top-left cell; negative values represent rows up from the range's top-left cell
    
    columnOffset - number of columns right from the range's top-left cell; negative values represent columns left from the range's top-left cell
    
    numRows - the height in rows of the new range
    
    numColumns - the width in columns of the new range
    
    Returns:
    
    the range for chaining
  - setValue
```
Range setValue(java.lang.Object value)
```
    Sets the value of the range.
    
    Parameters:
    
    value - the value for the range
    
    Returns:
    
    the range for chaining
  - setValues
```
Range setValues(java.lang.Object[][] values)
```
    Sets a rectangular sheet of values (must match dimensions of this range).
    
    Parameters:
    
    values - a two-dimensional array of values
    
    Returns:
    
    the range for chaining
  - sort
```
Range sort(java.lang.Object sortSpecObj)
```
    Sorts the cells in a given range, by column and order specified.
    
    Parameters:
    
    sortSpecObj - TODO
    
    Returns:
    
    the range, for chaining
  - forEach
```
void forEach(CellVisitor callback)
```
    Executes a provided function for each cell in the range
    
    Parameters:
    
    callback - a callback function which will be called for each cell. See CellVisitor for details.

Interface Range

Method Summary

Method Detail

activate

clear

getCell

getRow

getColumn

getLastRow

getLastColumn

getNumRows

getNumColumns

getSheet

getValue

getValues

isBlank

copyTo

moveTo

offset

offset

setValue

setValues

sort

forEach