faxel.annotation

Annotation Type ExcelSheet

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Documented
public @interface ExcelSheet

Annotation used to mark a Collection as ExcelSheet of Workbook. Collection will be then populated with sheet rows. One of name or index must be provided.
Example usage:

  @ExcelSheet(sheetName = "Person", startPosition = 1, maxPosition = 100, arrangement = DataArrangementType.ROW)
  private Collection<Person> people;
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
DataArrangementType	arrangement Indicates how to interpret data arrangement in this sheet.
int	index 0 based index of sheet - source of data of this Collection
int	maxPosition 0 based index of maxPosition positioned row or column to parse.
java.lang.String	name Name of sheet - source of data of this Collection
int	startPosition 0 based index of row or column to startPosition from parsing.

Element Detail

name

public abstract java.lang.String name

Name of sheet - source of data of this Collection

Returns:

Name of the sheet

Default:

""

index

public abstract int index

0 based index of sheet - source of data of this Collection

Returns:

Index of the sheet

Default:

-1

arrangement

public abstract DataArrangementType arrangement

Indicates how to interpret data arrangement in this sheet. Possible values are ROW or COLUMN

Returns:

Desired data arrangement type. Default is ROW

Default:

faxel.annotation.DataArrangementType.ROW

startPosition

public abstract int startPosition

0 based index of row or column to startPosition from parsing. Default is first row.

Returns:

index of first row or column to start processing from.

Default:

1

maxPosition

public abstract int maxPosition

0 based index of maxPosition positioned row or column to parse. Default is Integer.MAX_VALUE. If the actual length of data set is greater than this value then maxPosition will be ignored.

Returns:

index of last row or column to process.

Default:

2147483647