com.gizbel.excel.annotations

Annotation Type ExcelColumnHeader

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

This annotation is used to fetch the value from the Excel cell to a particular java class field based on the column header. 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	columnHeader Data extraction based on the column header instead of column index. If ExcelFactoryType is COLUMN_NAME_BASED then the first row will be treated as headers. These headers will be used later to fetch the data

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	expectedColumnIndex Specifies the expected column index for that particular header Helpful in validating excel header name against their expected index.

Element Detail

columnHeader

public abstract String columnHeader

Data extraction based on the column header instead of column index.
If ExcelFactoryType is COLUMN_NAME_BASED then the first row will be treated as headers.
These headers will be used later to fetch the data

Returns:

columnHeader

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:

""

expectedColumnIndex

public abstract String expectedColumnIndex

Specifies the expected column index for that particular header
Helpful in validating excel header name against their expected index.

Returns:

expectedColumnIndex

Default:

""