eu.easyrpa.openframework.google.sheets.annotations

Annotation Type GSheetColumn

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface GSheetColumn

Defines relation between field of record class and corresponding column or data of table on the sheet.

See Also:

Table

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
GSheetCellStyle[]	cellStyle Specifies style that should be applied to a row cell of related column.
Class<? extends ColumnFormatter>	formatter Specifies class of formatter that implements ColumnFormatter and performs dynamic styling or value modification for related column cells.
GSheetCellStyle[]	headerStyle Specifies style that should be applied to a header cell of related column.
Class<? extends FieldMapper>	mapper Specifies class of mapper that implements FieldMapper and extracts value for this field from table row data.
String[]	name Specifies name or hierarchy of names that identifies specific column of related table on the sheet.
int	order Specifies the order index of related column.
int	width Specifies the width of related column in pixels.

Element Detail

name

public abstract String[] name

Specifies name or hierarchy of names that identifies specific column of related table on the sheet.

If table has one-line header then value should be simple name of column. E.g. "Person Name".

If table has multi-line headers and necessary column is grouped with other columns the value should be array of names. This array includes names of all grouped columns in order from the top. E.g. lets take the following table:

Id	Person
	Name	Age
1	John	35
2	Mike	50

For column "Name" the value should be ["Person", "Name"].

For column "Age" the value should be ["Person", "Age"].

But for column "Id" the value can be simple "Id".

If field of record class doesn't have any direct relation with table columns the value of name can be left unspecified. In such case the value of such field should be populated via mapper().

Default:

{}

width

public abstract int width

Specifies the width of related column in pixels. Used in case of creation of new table based on class of records.

Default:

-1

order

public abstract int order

Specifies the order index of related column. Used during creation of new table or insertion of new records into existing table.

Default value: order index of the field definition in class of record

Default:

-1

headerStyle

public abstract GSheetCellStyle[] headerStyle

Specifies style that should be applied to a header cell of related column. Used in case of creation of new table based on class of records.

See Also:

GSheetCellStyle

Default:

{}

cellStyle

public abstract GSheetCellStyle[] cellStyle

Specifies style that should be applied to a row cell of related column. Used during creation of new table or insertion of new records into existing table.

See Also:

GSheetCellStyle

Default:

{}

formatter

public abstract Class<? extends ColumnFormatter> formatter

Specifies class of formatter that implements ColumnFormatter and performs dynamic styling or value modification for related column cells.

Default:

eu.easyrpa.openframework.google.sheets.function.ColumnFormatter.class

mapper

public abstract Class<? extends FieldMapper> mapper

Specifies class of mapper that implements FieldMapper and extracts value for this field from table row data.

Default:

eu.easyrpa.openframework.google.sheets.function.FieldMapper.class