eu.easyrpa.openframework.google.sheets

Class CellRef

java.lang.Object

eu.easyrpa.openframework.google.sheets.CellRef

public class CellRef
extends Object

Keeps information that identifies specific cell of the sheet.

Constructor Summary

Constructors

Constructor and Description
CellRef(int rowIndex, int colIndex) Creates a new sheet-free reference based on given row and column indexes.
CellRef(String cellRef) Creates a new reference based on given A1-style string.
CellRef(String sheetName, int rowIndex, int colIndex) Creates a new sheet-based reference based on given row and column indexes.
CellRef(String sheetName, int rowIndex, int colIndex, boolean isRowAbs, boolean isColAbs) Creates a new sheet-based reference.

Method Summary

Modifier and Type	Method and Description
String	convertNumToColString(int col) Takes in a 0-based base-10 column and returns its symbol representation.
boolean	equals(Object o)
String	formatAsRowColString() Formats this cell reference as string in R1C1-style.
String	formatAsRowColString(boolean includeSheetName) Formats this cell reference as string in R1C1-style.
String	formatAsString() Formats this cell reference as string in A1-style.
String	formatAsString(boolean includeSheetName) Formats this cell reference as string in A1-style.
int	getCol() Gets column index of this cell reference.
int	getRow() Gets row index of this cell reference.
String	getSheetName() Gets the name of related sheet.
int	hashCode()
boolean	isColAbsolute() Gets whether column index is absolute.
boolean	isRowAbsolute() Gets whether row index is absolute.
boolean	isSheetNameDefined() Checks whether related sheet name is defined for this cell reference (sheet-based or not).
void	setCol(int colIndex) Sets column index for this cell reference.
void	setColAbsolute(boolean colAbs) Sets column index as absolute.
void	setRow(int rowIndex) Sets row index for this cell reference.
void	setRowAbsolute(boolean rowAbs) Sets row index as absolute.
void	setSheetName(String sheetName) Sets the name of related sheet and makes this cell reference as sheet-based.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CellRef

public CellRef(String cellRef)

Creates a new reference based on given A1-style string.

Parameters:

cellRef - string representation of the reference in A1-style. E.g. "A3" or "Sheet1!A3"

CellRef

public CellRef(int rowIndex,
               int colIndex)

Creates a new sheet-free reference based on given row and column indexes.

Parameters:

rowIndex - 0-based row index of the reference.

colIndex - 0-based column index of the reference.

CellRef

public CellRef(String sheetName,
               int rowIndex,
               int colIndex)

Creates a new sheet-based reference based on given row and column indexes.

Parameters:

sheetName - name of related sheet.

rowIndex - 0-based row index of the reference.

colIndex - 0-based column index of the reference.

CellRef

public CellRef(String sheetName,
               int rowIndex,
               int colIndex,
               boolean isRowAbs,
               boolean isColAbs)

Creates a new sheet-based reference.

Parameters:

sheetName - name of related sheet.

rowIndex - 0-based row index of the reference.

colIndex - 0-based column index of the reference.

isRowAbs - true if row index should be absolute or false otherwise.

isColAbs - true if column index should be absolute or false otherwise.

Method Detail

getSheetName

public String getSheetName()

Gets the name of related sheet.

Returns:

name of related sheet or null if this cell reference is sheet-free.

setSheetName

public void setSheetName(String sheetName)

Sets the name of related sheet and makes this cell reference as sheet-based.

Parameters:

sheetName - the name of sheet to set.

getRow

public int getRow()

Gets row index of this cell reference.

Returns:

row index of this cell reference.

setRow

public void setRow(int rowIndex)

Sets row index for this cell reference.

Parameters:

rowIndex - 0-based row index to set.

getCol

public int getCol()

Gets column index of this cell reference.

Returns:

column index of this cell reference.

setCol

public void setCol(int colIndex)

Sets column index for this cell reference.

Parameters:

colIndex - 0-based column index to set.

isRowAbsolute

public boolean isRowAbsolute()

Gets whether row index is absolute.

Returns:

true if row index is absolute or false otherwise.

setRowAbsolute

public void setRowAbsolute(boolean rowAbs)

Sets row index as absolute.

Parameters:

rowAbs - true if row index should be absolute or false otherwise.

isColAbsolute

public boolean isColAbsolute()

Gets whether column index is absolute.

Returns:

true if column index is absolute or false otherwise.

setColAbsolute

public void setColAbsolute(boolean colAbs)

Sets column index as absolute.

Parameters:

colAbs - true if column index should be absolute or false otherwise.

formatAsString

public String formatAsString()

Formats this cell reference as string in A1-style. E.g. "A3" or "Sheet1!A3".

Returns:

string representation of this cell reference in A1-style.

formatAsString

public String formatAsString(boolean includeSheetName)

Formats this cell reference as string in A1-style. E.g. "A3" or "Sheet1!A3".

Parameters:

includeSheetName - set to false if necessary to exclude sheet name in the output string.

Returns:

string representation of this cell reference in A1-style.

formatAsRowColString

public String formatAsRowColString()

Formats this cell reference as string in R1C1-style. E.g. "R3C1:R20C7" or "Sheet1!R3C1:R20C7".

Returns:

string representation of this cell reference in R1C1-style.

formatAsRowColString

public String formatAsRowColString(boolean includeSheetName)

Formats this cell reference as string in R1C1-style. E.g. "R3C1:R20C7" or "Sheet1!R3C1:R20C7".

Parameters:

includeSheetName - set to false if necessary to exclude sheet name in the output string.

Returns:

string representation of this cell reference in R1C1-style.

isSheetNameDefined

public boolean isSheetNameDefined()

Checks whether related sheet name is defined for this cell reference (sheet-based or not).

Returns:

true is related sheet name is defined or false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

convertNumToColString

public String convertNumToColString(int col)

Takes in a 0-based base-10 column and returns its symbol representation.

Parameters:

col - 0-based column index to convert.

Returns:

column number in symbol format. E.g. convertNumToColString(3) returns "D"