eu.easyrpa.openframework.google.sheets

Class Cell

java.lang.Object

eu.easyrpa.openframework.google.sheets.Cell

public class Cell
extends Object

Represents specific cell of Spreadsheet document and provides functionality to work with it.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cell(Sheet parent, int rowIndex, int columnIndex) Creates a new instance of cell.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getColumnIndex() Gets column index of this cell.
SpreadsheetDocument	getDocument() Gets parent Spreadsheet document.
String	getFormula() Gets string with specified for this cell formula.
com.google.api.services.sheets.v4.model.CellData	getGCell() Returns underlay Google API object representing this cell.
CellRange	getMergedRegion() Gets merged region where this cell is hit.
Cell	getMergedRegionCell() Gets top-left cell of merged region where this cell is hit.
CellRef	getReference() Gets reference to this cell.
int	getRowIndex() Gets row index of this cell.
Sheet	getSheet() Gets parent sheet.
CellStyle	getStyle() Gets current style of this cell.
Object	getValue() Gets the value of this cell.
<T> T	getValue(Class<T> valueType) Gets the value of this cell and converts it to the type specified by valueType.
boolean	hasFormula() Checks whether formula is specified for this cell.
int	hashCode()
boolean	isEmpty() Checks whether this cell is empty.
boolean	isMerged() Checks whether this cell is merged with other neighbour cells.
void	setFormula(String newCellFormula) Sets formula for this cell.
void	setStyle(CellStyle newStyle) Sets and applies specific style for this cell.
void	setValue(Object value) Sets the value for this cell.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cell

protected Cell(Sheet parent,
               int rowIndex,
               int columnIndex)

Creates a new instance of cell.

Parameters:

parent - reference to parent sheet.

rowIndex - 0-based row index of the cell.

columnIndex - 0-based column index of the cell.

Method Detail

getDocument

public SpreadsheetDocument getDocument()

Gets parent Spreadsheet document.

Returns:

parent Spreadsheet document.

getSheet

public Sheet getSheet()

Gets parent sheet.

Returns:

parent sheet.

getRowIndex

public int getRowIndex()

Gets row index of this cell.

Returns:

0-based row index of this cell.

getColumnIndex

public int getColumnIndex()

Gets column index of this cell.

Returns:

0-based column index of this cell.

getReference

public CellRef getReference()

Gets reference to this cell.

Returns:

this cell reference.

See Also:

CellRef

getStyle

public CellStyle getStyle()

Gets current style of this cell.

Returns:

object that keeps all style parameters of this cell.

See Also:

CellStyle

setStyle

public void setStyle(CellStyle newStyle)

Sets and applies specific style for this cell.

Parameters:

newStyle - the cell style to apply.

See Also:

CellStyle

getValue

public Object getValue()

Gets the value of this cell.

Returns:

current value of this cell. The actual class of value is depend on cell type. Can be returned Double, Boolean, LocalDateTime or String.

getValue

public <T> T getValue(Class<T> valueType)

Gets the value of this cell 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 value to corresponding type or return null if the conversion fails.

For other types it performs simple type casting of cell value to T or throws ClassCastException if such type casting is not possible.

Type Parameters:

T - type of return value. Defined by value of valueType.

Parameters:

valueType - class instance of return value.

Returns:

value of this cell. 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(Object value)

Sets the value for this cell.

Parameters:

value - the value to set.

isEmpty

public boolean isEmpty()

Checks whether this cell is empty.

Returns:

true if this cell is not defined, blank or has empty value. Returns false otherwise.

hasFormula

public boolean hasFormula()

Checks whether formula is specified for this cell.

Returns:

true if the formula is specified for this cell or false otherwise.

getFormula

public String getFormula()

Gets string with specified for this cell formula.

Returns:

string with specified for this cell formula or null if cell does not have formula.

setFormula

public void setFormula(String newCellFormula)

Sets formula for this cell.

Parameters:

newCellFormula - string with formula to set.

isMerged

public boolean isMerged()

Checks whether this cell is merged with other neighbour cells.

Returns:

true if this cell is merged with other neighbour cells or false otherwise.

getMergedRegion

public CellRange getMergedRegion()

Gets merged region where this cell is hit.

Returns:

object representing merged region of this cell or null if this cell is not merged with other cells.

See Also:

CellRange

getMergedRegionCell

public Cell getMergedRegionCell()

Gets top-left cell of merged region where this cell is hit.

Returns:

object representing top-left cell of merged region of this cell or null if this cell is not merged with other cells.

getGCell

public com.google.api.services.sheets.v4.model.CellData getGCell()

Returns underlay Google API object representing this cell. This object can be used directly if some specific Google API functionality is necessary within RPA process.

Returns:

Google API object representing this cell.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object