Column (EasyRPA Open Framework - Google Sheets 1.0.0 API)

java.lang.Object
- eu.easyrpa.openframework.google.sheets.Column

All Implemented Interfaces:

Iterable<Cell>
```
public class Column
extends Object
implements Iterable<Cell>
```
Represents specific column of Spreadsheet document and provides functionality to work with it.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Column(Sheet parent, int columnIndex)
Creates a new instance of column.

Constructors
Modifier	Constructor and Description
`protected`	`Column(Sheet parent, int columnIndex)` Creates a new instance of column.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cell`	`createCell(int rowIndex)` Creates a new cell at the given row index and returns its representing object.
`Cell`	`getCell(int rowIndex)` Gets the cell of this column represented by given row index.
`Cell`	`getCell(String cellRef)` Gets the cell of this column represented by given reference.
`SpreadsheetDocument`	`getDocument()` Gets parent Spreadsheet document.
`int`	`getFirstRowIndex()` Gets row index of the first defined cell at this column.
`int`	`getIndex()` Gets index of this column.
`int`	`getLastRowIndex()` Gets row index of the last cell of this column.
`List<Object>`	`getRange(int startRow, int endRow)` Gets values of cells range on this column.
`<T> List<T>`	`getRange(int startRow, int endRow, Class<T> valueType)` Gets values of cells range on this column and converts them to the type specified by `valueType`.
`List<Object>`	`getRange(String startRef, String endRef)` Gets values of cells range of this column.
`<T> List<T>`	`getRange(String startRef, String endRef, Class<T> valueType)` Gets values of cells range on this column and converts them to the type specified by `valueType`.
`CellRef`	`getReference()` Gets reference to this column.
`Sheet`	`getSheet()` Gets parent sheet.
`Object`	`getValue(int rowIndex)` Gets the value of this column cell by given row index.
`<T> T`	`getValue(int rowIndex, Class<T> valueType)` Gets the value of this column cell by given row index.
`Object`	`getValue(String cellRef)` Gets the value of this column cell by given cell reference.
`<T> T`	`getValue(String cellRef, Class<T> valueType)` Gets the value of this column cell by given cell reference and converts it to the type specified by `valueType`.
`List<Object>`	`getValues()` Gets values of all column cells.
`<T> List<T>`	`getValues(Class<T> valueType)` Gets values of all column cells.
`boolean`	`isEmpty()` Checks whether this column is empty.
`Iterator<Cell>`	`iterator()` Returns an iterator of objects representing existing cells of this column.
`void`	`putRange(int startRow, List<?> values)` Sets given values to cells range of this column which starts from cell with row index defined by `startRow`.
`void`	`putRange(String startRef, List<?> values)` Sets given values to cells range of this column which starts from cell defined by `startRef`.
`void`	`setValue(int rowIndex, Object value)` Sets the value of this column cell by given row index.
`void`	`setValue(String cellRef, Object value)` Sets the value of this column cell by given cell reference.
`void`	`setValues(List<?> values)` Sets given values to cells range of this column which starts from cell with row index 0.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Column
```
protected Column(Sheet parent,
                 int columnIndex)
```
    Creates a new instance of column.
    
    Parameters:
    
    parent - reference to parent sheet.
    
    columnIndex - 0-based index of this column.
- Method Detail
  - getDocument
```
public SpreadsheetDocument getDocument()
```
    Gets parent Spreadsheet document.
    
    Returns:
    
    parent Spreadsheet document.
  - getSheet
```
public Sheet getSheet()
```
    Gets parent sheet.
    
    Returns:
    
    parent sheet.
  - getIndex
```
public int getIndex()
```
    Gets index of this column.
    
    Returns:
    
    0-based index of this column.
  - getReference
```
public CellRef getReference()
```
    Gets reference to this column.
    Column reference is a reference to its cell with row index 0.
    
    Returns:
    
    this column reference.
    
    See Also:
    
    CellRef
  - getValue
```
public Object getValue(String cellRef)
```
    Gets the value of this column cell by given cell reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The actual class of value is depend on cell type. Can be returned Double, Boolean, LocalDateTime or String.
  - getValue
```
public <T> T getValue(String cellRef,
                      Class<T> valueType)
```
    Gets the value of this column cell by given cell reference and converts it to the type specified by valueType.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning value. Defined by value of valueType.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    valueType - class instance of returning value.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The class of return value is defined by valueType. If the actual class of cell value is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - getValue
```
public Object getValue(int rowIndex)
```
    Gets the value of this column cell by given row index.
    
    Parameters:
    
    rowIndex - 0-based row index of the cell.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The actual class of value is depend on cell type. Can be returned Double, Boolean, LocalDateTime or String.
  - getValue
```
public <T> T getValue(int rowIndex,
                      Class<T> valueType)
```
    Gets the value of this column cell by given row index. The return value is automatically converted to the type specified by valueType.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning value. Defined by value of valueType.
    
    Parameters:
    
    rowIndex - 0-based row index of the cell.
    
    valueType - class instance of returning value.
    
    Returns:
    
    value of corresponding cell or null if nothing is found. The class of return value is defined by valueType. If the actual class of cell value is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - setValue
```
public void setValue(String cellRef,
                     Object value)
```
    Sets the value of this column cell by given cell reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. E.g. "A23".
    
    value - the value to set.
  - setValue
```
public void setValue(int rowIndex,
                     Object value)
```
    Sets the value of this column cell by given row index.
    
    Parameters:
    
    rowIndex - 0-based row index of the cell.
    
    value - the value to set.
  - getValues
```
public List<Object> getValues()
```
    Gets values of all column cells.
    It's an equivalent to getting of range between first and last cells of this column.
    
    Returns:
    
    list of values of this column cells. Returns empty list if column is empty. The actual class of values in list depend on cell types. Can be Double, Boolean, LocalDateTime or String.
    
    See Also:
    
    getRange(int, int, Class), getFirstRowIndex(), getLastRowIndex()
  - getValues
```
public <T> List<T> getValues(Class<T> valueType)
```
    Gets values of all column cells.
    Returning values are automatically converted to the type specified by valueType.
    It's an equivalent to getting of range between first and last cells of this column.
    
    Type Parameters:
    
    T - type of returning values. Defined by value of valueType.
    
    Parameters:
    
    valueType - class instance of returning values.
    
    Returns:
    
    list of values of this column cells. Returns empty list if column is empty. The class of returning values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    See Also:
    
    getRange(int, int, Class), getFirstRowIndex(), getLastRowIndex()
  - setValues
```
public void setValues(List<?> values)
```
    Sets given values to cells range of this column which starts from cell with row index 0.
    The end cell of the range is defined by size of given values.
    It's an equivalent to putRange(0, values).
    
    Parameters:
    
    values - list of values to set.
    
    See Also:
    
    putRange(int, List)
  - getRange
```
public List<Object> getRange(String startRef,
                             String endRef)
```
    Gets values of cells range of this column. The range is defined by given start and end cell references.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. Only row part is taken into consideration. E.g. "A5".
    
    endRef - reference string to the end cell of the range. Only row part is taken into consideration. E.g. "A23".
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The actual class of values in list depend on cell types. Can be Double, Boolean, LocalDateTime or String.
    
    See Also:
    
    getRange(int, int, Class)
  - getRange
```
public <T> List<T> getRange(String startRef,
                            String endRef,
                            Class<T> valueType)
```
    Gets values of cells range on this column and converts them to the type specified by valueType. The range is defined by given start and end cell references.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning cell values. Defined by value of valueType.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. Only row part is taken into consideration. E.g. "A5".
    
    endRef - reference string to the end cell of the range. Only row part is taken into consideration. E.g. "A23".
    
    valueType - class instance of returning cell values.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The class of return cell values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - getRange
```
public List<Object> getRange(int startRow,
                             int endRow)
```
    Gets values of cells range on this column. The range is defined by given top and bottom row indexes.
    
    Parameters:
    
    startRow - 0-based index of top row of the range.
    
    endRow - 0-based index of bottom row of the range.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The actual class of values depend on cell types. Can be Double, Boolean, LocalDateTime or String.
  - getRange
```
public <T> List<T> getRange(int startRow,
                            int endRow,
                            Class<T> valueType)
```
    Gets values of cells range on this column and converts them to the type specified by valueType. The range is defined by given top and bottom row indexes.
    If valueType is String.class, Byte.class, Short.class, Integer.class, Long.class, Float.class or Double.class this method performs automatic conversion of cell values to corresponding type or null if the conversion fails.
    For other types it performs simple type casting of cell values to T or throws ClassCastException if such type casting is not possible.
    
    Type Parameters:
    
    T - type of returning cell values. Defined by value of valueType.
    
    Parameters:
    
    startRow - 0-based index of top row of the range.
    
    endRow - 0-based index of bottom row of the range.
    
    valueType - class instance of returning cell values.
    
    Returns:
    
    list of values of the cells range. Returns empty list if specified range is empty. The class of return cell values is defined by valueType. If the actual class of cell values is different from valueType the automatic conversion will be applied.
    
    Throws:
    
    ClassCastException - if T is different from String or Number and the value of cell cannot be cast to T.
  - putRange
```
public void putRange(String startRef,
                     List<?> values)
```
    Sets given values to cells range of this column which starts from cell defined by startRef.
    The end cell of the range is defined by size of given values.
    
    Parameters:
    
    startRef - reference string to the start cell of the range. E.g. "A23".
    
    values - list of values to set.
  - putRange
```
public void putRange(int startRow,
                     List<?> values)
```
    Sets given values to cells range of this column which starts from cell with row index defined by startRow.
    The end cell of the range is defined by size of given values.
    
    Parameters:
    
    startRow - 0-based row index of the start cell of the range.
    
    values - list of values to set.
  - getCell
```
public Cell getCell(String cellRef)
```
    Gets the cell of this column represented by given reference.
    
    Parameters:
    
    cellRef - reference string to necessary cell. Only row part is taken into consideration. E.g. "A23".
    
    Returns:
    
    instance of corresponding cell or null if cell is not defined.
  - getCell
```
public Cell getCell(int rowIndex)
```
    Gets the cell of this column represented by given row index.
    
    Parameters:
    
    rowIndex - 0-based row index of necessary cell.
    
    Returns:
    
    instance of corresponding cell or null if cell is not defined.
  - createCell
```
public Cell createCell(int rowIndex)
```
    Creates a new cell at the given row index and returns its representing object.
    
    Parameters:
    
    rowIndex - 0-based row index where cell should be created.
    
    Returns:
    
    object representing the created cell.
  - getFirstRowIndex
```
public int getFirstRowIndex()
```
    Gets row index of the first defined cell at this column.
    Cell is defined if underlying Google CellData object is not null.
    
    Returns:
    
    0-based row index of the first defined cell at this column or -1 if no cells exist (column is empty).
  - getLastRowIndex
```
public int getLastRowIndex()
```
    Gets row index of the last cell of this column.
    
    Returns:
    
    0-based row index of the last cell of this column or -1 if no cells exist (column is empty).
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether this column is empty.
    
    Returns:
    
    true if all cells of this column are not defined, blank or has empty values. Returns false otherwise.
  - iterator
```
public Iterator<Cell> iterator()
```
    Returns an iterator of objects representing existing cells of this column. Meaning it won't iterate over undefined cells.
    >This method allows using of this column object in "for" loop:
```
     for(Cell cell: column){
         int rowIndex = cell.getRowIndex();
         ...
     }
 
```
    Specified by:
    
    iterator in interface Iterable<Cell>
    
    Returns:
    
    on iterator of objects representing existing cell of this column.

Class Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Column

Method Detail

getDocument

getSheet

getIndex

getReference

getValue

getValue

getValue

getValue

setValue

setValue

getValues

getValues

setValues

getRange

getRange

getRange

getRange

putRange

putRange

getCell

getCell

createCell

getFirstRowIndex

getLastRowIndex

isEmpty

iterator