eu.easyrpa.openframework.google.sheets

Class Table<T>

java.lang.Object

eu.easyrpa.openframework.google.sheets.Table<T>

Type Parameters:

T - type of table records. Should be POJO class with at least one field annotated with GSheetTable.

All Implemented Interfaces:

Iterable<T>

public class Table<T>
extends Object
implements Iterable<T>

Represents rectangle area of cells on the sheet where the top row or rows has titles of corresponding columns.

The table is defined by its header bounds (headers top row, left column, bottom row and right column) and the index of the last row (bottom row). If bottom row is not specified then table ends at the last row of the sheet.

The content of table is represented with list of records. Record is an instance of POJO class where some fields are mapped to corresponding table columns using GSheetTable annotations. Each record corresponds to specific row of the table and indexed (0-based) starting with the row right below the header bottom row.

See Also:

GSheetColumn, GSheetCellStyle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Table(Sheet parent, int headerTopRow, int headerLeftCol, int headerBottomRow, int headerRightCol, Class<T> recordType) Creates a new instance of table that is defined by existing cells range on specified sheet.
protected	Table(Sheet parent, int topRow, int leftCol, List<T> records) Builds a new table on the given sheet at position defined by topRow and leftCol (top-left cell of the table).

Method Summary

Modifier and Type	Method and Description
void	addRecord(T record) Adds a new record at the end of this table.
void	addRecords(List<T> records) Adds list of records at the end of this table.
void	clearCache() Clears records cache.
T	findRecord(Predicate<T> isSatisfy) Iterates over all records starting from the first till the moment when isSatisfy is return true for some record.
int	findRecordIndex(Predicate<T> isSatisfy) Iterates over all records starting from the first till the moment when isSatisfy is return true for some record.
int	getBottomRow() Gets index of the last row of this table.
Map<String,Integer>	getColumnNameToIndexMap() Gets map that maps column titles to its ordering number (0-based).
int	getHeaderBottomRow() Gets index of the bottom row of this table header.
int	getHeaderLeftCol() Gets index of the left column of this table header.
int	getHeaderRightCol() Gets index of the right column of this table header.
int	getHeaderTopRow() Gets index of the top row of this table header.
T	getRecord(int index) Gets specific record by its index.
List<T>	getRecords() Gets full list of records that are contained in this table.
int	getRecordsCount() Gets amount of records that contained in this table.
Sheet	getSheet() Gets parent sheet.
int	indexOf(T record) Gets index of given record.
void	insertRecord(InsertMethod method, int recordIndex, T record) Inserts new record into this table at given position.
void	insertRecord(InsertMethod method, T relatedRecord, T record) Inserts new record into this table at given position.
void	insertRecords(InsertMethod method, int recordIndex, List<T> records) Inserts list of records into this table at given position.
void	insertRecords(InsertMethod method, T relatedRecord, List<T> records) Inserts list of records into this table at given position.
Iterator<T>	iterator() Gets an iterator of records contained in this table.
void	removeRecord(T record) Removes given record and corresponding row from this table.
void	removeRecords(List<T> records) Removes given records and corresponding rows from this table.
void	setBottomRow(int bottomRowIndex) Sets index of the last row of this table explicitly.
void	setHeaderBottomRow(int bottomRowIndex) Sets new index of the bottom row of this table header.
void	setHeaderLeftCol(int leftColIndex) Sets new index of the left column of this table header.
void	setHeaderRightCol(int rightColIndex) Sets new index of the right column of this table header.
void	setHeaderTopRow(int topRowIndex) Sets new index of the top row of this table header.
void	trimLeadingAndTrailingSpaces() Analyzes content of leading and trailing columns and if these columns are empty shifts indexes of left and right columns to exclude them from this table bounds.
void	updateRecord(T record) Transfers changes that have been done within given record to corresponding row of the sheet.
void	updateRecords(List<T> records) Transfers changes that have been done within given records to corresponding rows of the sheet.

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

Table

protected Table(Sheet parent,
                int topRow,
                int leftCol,
                List<T> records)

Builds a new table on the given sheet at position defined by topRow and leftCol (top-left cell of the table).

Parameters:

parent - parent sheet where the table should be placed.

topRow - 0-based index of row that defines top-left cell of the table.

leftCol - 0-based index of column that defines top-left cell of the table.

records - list of records to insert into the table after creation. Also this list provides information about type of records with meta-information is necessary for table construction. That's why this list should not be empty.

Table

protected Table(Sheet parent,
                int headerTopRow,
                int headerLeftCol,
                int headerBottomRow,
                int headerRightCol,
                Class<T> recordType)

Creates a new instance of table that is defined by existing cells range on specified sheet.

Parameters:

parent - the parent sheet where this table is located.

headerTopRow - 0-based index of table header top row.

headerLeftCol - 0-based index of table left column.

headerBottomRow - 0-based index of table header bottom row.

headerRightCol - 0-based index of table right column.

recordType - class instance of records that this table should works with.

Method Detail

getSheet

public Sheet getSheet()

Gets parent sheet.

Returns:

parent sheet.

getHeaderTopRow

public int getHeaderTopRow()

Gets index of the top row of this table header.

Returns:

0-based index of the top row of this table header.

setHeaderTopRow

public void setHeaderTopRow(int topRowIndex)

Sets new index of the top row of this table header.

Parameters:

topRowIndex - the new index of the top row to set.

getHeaderLeftCol

public int getHeaderLeftCol()

Gets index of the left column of this table header.

Returns:

0-based index of the left column of this table header.

setHeaderLeftCol

public void setHeaderLeftCol(int leftColIndex)

Sets new index of the left column of this table header.

Parameters:

leftColIndex - the new index of the left column to set.

getHeaderBottomRow

public int getHeaderBottomRow()

Gets index of the bottom row of this table header.

Returns:

0-based index of the bottom row of this table header.

setHeaderBottomRow

public void setHeaderBottomRow(int bottomRowIndex)

Sets new index of the bottom row of this table header.

Parameters:

bottomRowIndex - the new index of the bottom row to set.

getHeaderRightCol

public int getHeaderRightCol()

Gets index of the right column of this table header.

Returns:

0-based index of the right column of this table header.

setHeaderRightCol

public void setHeaderRightCol(int rightColIndex)

Sets new index of the right column of this table header.

Parameters:

rightColIndex - the new index of the right column to set.

getBottomRow

public int getBottomRow()

Gets index of the last row of this table.

If the bottom row is not specified explicitly this method returns the actual index of the last row of parent sheet.

Returns:

an actual index of the last row of this table.

setBottomRow

public void setBottomRow(int bottomRowIndex)

Sets index of the last row of this table explicitly.

It's necessary to use when the table ends earlier than the last row of the parent sheet. Once this bottom row index is specified it will be automatically corrected during adding, inserting or removing records.

Parameters:

bottomRowIndex - 0-based index of the row that should be the last row of this table.

getColumnNameToIndexMap

public Map<String,Integer> getColumnNameToIndexMap()

Gets map that maps column titles to its ordering number (0-based).

It's necessary to properly map table records to corresponding row data and vice versa.

Returns:

map that maps column titles to its ordering number.

getRecords

public List<T> getRecords()

Gets full list of records that are contained in this table.

Returns:

list of table records.

getRecord

public T getRecord(int index)

Gets specific record by its index.

Records are indexed starting with the row right below the header bottom row.

Parameters:

index - 0-based index of the record to get.

Returns:

instance of corresponding record or null if record at such index is not exist.

findRecord

public T findRecord(Predicate<T> isSatisfy)

Iterates over all records starting from the first till the moment when isSatisfy is return true for some record.

Parameters:

isSatisfy - lambda expression that accepts instance of each record and should return true if the record satisfies to some condition.

Returns:

instance of record for which isSatisfy returned true or null if there are no such records.

findRecordIndex

public int findRecordIndex(Predicate<T> isSatisfy)

Iterates over all records starting from the first till the moment when isSatisfy is return true for some record.

Parameters:

isSatisfy - lambda expression that accepts instance of each record and should return true if the record satisfies to some condition.

Returns:

index of record for which isSatisfy returned true or -1 if there are no such records.

indexOf

public int indexOf(T record)

Gets index of given record.

Parameters:

record - instance of record to lookup.

Returns:

index of given record or -1 if record does not belong to this table.

getRecordsCount

public int getRecordsCount()

Gets amount of records that contained in this table.

Returns:

amount of records of this table.

addRecord

public void addRecord(T record)

Adds a new record at the end of this table.

The record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after row adding.

Parameters:

record - the record to add.

addRecords

public void addRecords(List<T> records)

Adds list of records at the end of this table.

Each record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after rows adding.

Parameters:

records - list of records to add.

insertRecord

public void insertRecord(InsertMethod method,
                         T relatedRecord,
                         T record)

Inserts new record into this table at given position.

The record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after row inserting.

Parameters:

method - defines position for insertion relatively to record specified by relatedRecord.

relatedRecord - the record that identifies position for insertion.

record - the record to insert.

insertRecord

public void insertRecord(InsertMethod method,
                         int recordIndex,
                         T record)

Inserts new record into this table at given position.

The record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after row inserting.

Parameters:

method - defines position for insertion relatively to record index specified by recordIndex.

recordIndex - the index of record that identifies position for insertion.

record - the record to insert.

insertRecords

public void insertRecords(InsertMethod method,
                          T relatedRecord,
                          List<T> records)

Inserts list of records into this table at given position.

Each record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after rows inserting.

Parameters:

method - defines position for insertion relatively to record specified by relatedRecord.

relatedRecord - the record that identifies position for insertion.

records - list of records to insert.

insertRecords

public void insertRecords(InsertMethod method,
                          int recordIndex,
                          List<T> records)

Inserts list of records into this table at given position.

Each record will be converted to corresponding row data based on information specified within GSheetColumn annotations. These annotations also provide styling information that is applied after rows inserting.

Parameters:

method - defines position for insertion relatively to record index specified by recordIndex.

recordIndex - the index of record that identifies position for insertion.

records - list of records to insert.

updateRecord

public void updateRecord(T record)

Transfers changes that have been done within given record to corresponding row of the sheet.

Parameters:

record - the record to update.

updateRecords

public void updateRecords(List<T> records)

Transfers changes that have been done within given records to corresponding rows of the sheet.

Parameters:

records - list of records to update.

removeRecord

public void removeRecord(T record)

Removes given record and corresponding row from this table.

Do nothing if the record is null or does not belong to this table.

Parameters:

record - the record to remove.

removeRecords

public void removeRecords(List<T> records)

Removes given records and corresponding rows from this table.

Parameters:

records - list of records to remove. Do nothing if this list is null.

clearCache

public void clearCache()

Clears records cache.

trimLeadingAndTrailingSpaces

public void trimLeadingAndTrailingSpaces()

Analyzes content of leading and trailing columns and if these columns are empty shifts indexes of left and right columns to exclude them from this table bounds.

iterator

public Iterator<T> iterator()

Gets an iterator of records contained in this table.

This method allows using of this table object in "for" loop:

     for(T record: table){
         ...
     }
 

Specified by:

iterator in interface Iterable<T>

Returns:

on iterator of records contained in this table.