eu.easyrpa.openframework.google.sheets

Class CellRange

java.lang.Object

eu.easyrpa.openframework.google.sheets.CellRange

public class CellRange
extends Object

Keeps information that identifies specific rectangle area of sheet cells.

Constructor Summary

Constructors

Constructor and Description
CellRange(com.google.api.services.sheets.v4.model.GridRange gridRange) Creates a new range based on given Google GridRange.
CellRange(int firstRow, int firstCol, int lastRow, int lastCol) Creates a new sheet-free range based on given row and column indexes.
CellRange(String rangeRef) Creates a new range based on given A1-style string.
CellRange(String sheetName, int firstRow, int firstCol, int lastRow, int lastCol) Creates a new sheet-based range based on given row and column indexes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	formatAsRowColString() Formats this range as string in R1C1-style.
String	formatAsString() Formats this range as string in A1-style.
int	getColumnsCount() Gets amount of columns in this range (range width).
int	getFirstCol() Gets index of the left column of this range.
int	getFirstRow() Gets index of the top row of this range.
int	getLastCol() Gets index of the right column of this range.
int	getLastRow() Gets index of the bottom row of this range.
int	getRowsCount() Gets amount of rows in this range (range height).
String	getSheetName() Gets the name of related sheet.
int	hashCode()
boolean	intersects(CellRange other) Determines whether this range intersects with given CellRange.
boolean	isFirstColAbsolute() Gets whether index of the left column is absolute.
boolean	isFirstRowAbsolute() Gets whether index of the top row is absolute.
boolean	isInRange(CellRange range) Determines if the given CellRange lies within the bounds of this range.
boolean	isInRange(CellRef ref) Determines if the given CellRef lies within the bounds of this range.
boolean	isInRange(int rowInd, int colInd) Determines if the given coordinates lie within the bounds of this range.
boolean	isLastColAbsolute() Gets whether index of the right column is absolute.
boolean	isLastRowAbsolute() Gets whether index of the bottom row is absolute.
boolean	isSheetNameDefined() Checks whether related sheet name is defined for this range (sheet-based or not).
void	setFirstCol(int colIndex) Sets index of the left column for this range.
void	setFirstColAbsolute(boolean colAbs) Sets index of the left column as absolute.
void	setFirstRow(int rowIndex) Sets index of the top row for this range.
void	setFirstRowAbsolute(boolean rowAbs) Sets index of the top row as absolute.
void	setLastCol(int colIndex) Sets index of the right column for this range.
void	setLastColAbsolute(boolean colAbs) Sets index of the right column as absolute.
void	setLastRow(int rowIndex) Sets index of the bottom row for this range.
void	setLastRowAbsolute(boolean rowAbs) Sets index of the bottom row as absolute.
void	setSheetName(String sheetName) Sets the name of related sheet and makes this range as sheet-based.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CellRange

public CellRange(String rangeRef)

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

Parameters:

rangeRef - string representation of the range in A1-style. E.g. "A3:G20" or "Sheet1!A3:G20"

CellRange

public CellRange(int firstRow,
                 int firstCol,
                 int lastRow,
                 int lastCol)

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

Parameters:

firstRow - 0-based index of the top row of the range.

firstCol - 0-based index of the left column of the range.

lastRow - 0-based index of the bottom row of the range.

lastCol - 0-based index of the right column of the range.

CellRange

public CellRange(String sheetName,
                 int firstRow,
                 int firstCol,
                 int lastRow,
                 int lastCol)

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

Parameters:

sheetName - name of related sheet.

firstRow - 0-based index of the top row of the range on related sheet.

firstCol - 0-based index of the left column of the range on related sheet.

lastRow - 0-based index of the bottom row of the range on related sheet.

lastCol - 0-based index of the right column of the range on related sheet.

CellRange

public CellRange(com.google.api.services.sheets.v4.model.GridRange gridRange)

Creates a new range based on given Google GridRange.

Parameters:

gridRange - the source {@link GridRange) object.

Method Detail

getSheetName

public String getSheetName()

Gets the name of related sheet.

Returns:

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

setSheetName

public void setSheetName(String sheetName)

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

Parameters:

sheetName - the name of sheet to set.

getFirstRow

public int getFirstRow()

Gets index of the top row of this range.

Returns:

index of the top row of this range.

setFirstRow

public void setFirstRow(int rowIndex)

Sets index of the top row for this range.

Parameters:

rowIndex - 0-based row index to set.

getFirstCol

public int getFirstCol()

Gets index of the left column of this range.

Returns:

index of the left column of this range.

setFirstCol

public void setFirstCol(int colIndex)

Sets index of the left column for this range.

Parameters:

colIndex - 0-based column index to set.

getLastRow

public int getLastRow()

Gets index of the bottom row of this range.

Returns:

index of the bottom row of this range.

setLastRow

public void setLastRow(int rowIndex)

Sets index of the bottom row for this range.

Parameters:

rowIndex - 0-based row index to set.

getLastCol

public int getLastCol()

Gets index of the right column of this range.

Returns:

index of the right column of this range.

setLastCol

public void setLastCol(int colIndex)

Sets index of the right column for this range.

Parameters:

colIndex - 0-based column index to set.

isFirstRowAbsolute

public boolean isFirstRowAbsolute()

Gets whether index of the top row is absolute.

Returns:

true if index of the top row is absolute or false otherwise.

setFirstRowAbsolute

public void setFirstRowAbsolute(boolean rowAbs)

Sets index of the top row as absolute.

Parameters:

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

isFirstColAbsolute

public boolean isFirstColAbsolute()

Gets whether index of the left column is absolute.

Returns:

true if index of the left column is absolute or false otherwise.

setFirstColAbsolute

public void setFirstColAbsolute(boolean colAbs)

Sets index of the left column as absolute.

Parameters:

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

isLastRowAbsolute

public boolean isLastRowAbsolute()

Gets whether index of the bottom row is absolute.

Returns:

true if index of the bottom row is absolute or false otherwise.

setLastRowAbsolute

public void setLastRowAbsolute(boolean rowAbs)

Sets index of the bottom row as absolute.

Parameters:

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

isLastColAbsolute

public boolean isLastColAbsolute()

Gets whether index of the right column is absolute.

Returns:

true if index of the right column is absolute or false otherwise.

setLastColAbsolute

public void setLastColAbsolute(boolean colAbs)

Sets index of the right column as absolute.

Parameters:

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

getColumnsCount

public int getColumnsCount()

Gets amount of columns in this range (range width).

Returns:

amount of columns in this range.

getRowsCount

public int getRowsCount()

Gets amount of rows in this range (range height).

Returns:

amount of rows in this range.

formatAsString

public String formatAsString()

Formats this range as string in A1-style. E.g. "A3:G20" or "Sheet1!A3:G20".

Returns:

string representation of this range in A1-style.

formatAsRowColString

public String formatAsRowColString()

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

Returns:

string representation of this range in R1C1-style.

isSheetNameDefined

public boolean isSheetNameDefined()

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

Returns:

true is related sheet name is defined or false otherwise.

isInRange

public boolean isInRange(int rowInd,
                         int colInd)

Determines if the given coordinates lie within the bounds of this range.

Parameters:

rowInd - 0-based row index to check.

colInd - 0-based column index to check.

Returns:

true if given coordinates lie within the bounds or false otherwise.

isInRange

public boolean isInRange(CellRef ref)

Determines if the given CellRef lies within the bounds of this range.

Parameters:

ref - the cell reference to check.

Returns:

true if given reference lie within the bounds or false otherwise.

isInRange

public boolean isInRange(CellRange range)

Determines if the given CellRange lies within the bounds of this range.

Parameters:

range - the cells range to check.

Returns:

true if given range lies within the bounds or false otherwise.

intersects

public boolean intersects(CellRange other)

Determines whether this range intersects with given CellRange.

Parameters:

other - the cells range to check for intersection with this range.

Returns:

true if ranges have at least 1 cell in common or false otherwise.

See Also:

for checking if a single cell intersects

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