com.gizbel.excel.annotations

Annotation Type ExcelColumnIndex

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

This annotation is used to fetch the value from the Excel cell to a particular java class field based on column index. Not applicable for inherited fields

Author:

Saket Kumar

See Also:

dataType(), defaultValue()

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	columnIndex Zero based column index can be used to pull cell data in the annotated field. For instance : Any field annotated with columnIndex("2"), that field will be initialized with the value contained in column number 2 starting from 0.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	dataType Specify the cell data type, if dataType is provided the extracted cell value is parsed and converted into specified dataType.
String	defaultValue Specifies the default value, if data is not found in the cell ( either blank or null ), then it will put the default value Default values will also be casted in their dataType
String	expectedColumnName Specifies the expected column name at that particular index. Helpful in validating excel column index against expected columns.

Element Detail

columnIndex

public abstract String columnIndex

Zero based column index can be used to pull cell data in the annotated field.
For instance : Any field annotated with columnIndex("2"), that field will be initialized with the value contained in column number 2 starting from 0.

Returns:

columnIndex

dataType

public abstract String dataType

Specify the cell data type, if dataType is provided the extracted cell value is parsed and converted into specified dataType. possible values are

• "int" : returns the Integer value
• "long" : returns the long value
• "bool" : returns the boolean representation
• "string" returns string representation, it's by default
• "double" returns the double value
• "date" returns the java.util.date object

Returns:

dataType

Default:

"string"

defaultValue

public abstract String defaultValue

Specifies the default value, if data is not found in the cell ( either blank or null ), then it will put the default value
Default values will also be casted in their dataType

Returns:

defaultValue

Default:

""

expectedColumnName

public abstract String expectedColumnName

Specifies the expected column name at that particular index.
Helpful in validating excel column index against expected columns.

Returns:

expectedColumnName

Default:

""