org.apache.camel.dataformat.bindy.annotation

Annotation Type DataField

@Documented
 @Retention(value=RUNTIME)
public @interface DataField

An annotation used to identify in a POJO which property is link to a field of a record (csv, ...). The pos (mandatory) identifies the position of the data in the record The name is optional and could be used in the future to bind a property which a different name The columnName (optional) represents the name of the column who will appear in the header The pattern (optional) allows to define the pattern of the data (useful for Date, ...) The length (optional) allows to define for fixed length message the size of the data's block The precision(optional) reflects the precision to be used with BigDecimal number The position (optional) identify the position of the field in the CSV generated The required (optional) property identifies a field which is mandatory. The lengthPos (optional) identifies a field in this record that defines the fixed length for this field. The delimiter (optional) defines a character that is used to demarcate the field, if it has a variable length.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	pos Position of the data in the input record, must start from 1 (mandatory).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	align Align the text to the right or left.
boolean	clip Indicates to clip data in the field if it exceeds the allowed length when using fixed length.
String	columnName Name of the header column (optional)
String	decimalSeparator Decimal Separator to be used with BigDecimal number
String	defaultValue Field's default value in case no value is set
String	delimiter Optional delimiter to be used if the field has a variable length
String	groupingSeparator Grouping Separator to be used with BigDecimal number when we would like to format/parse to number with grouping e.g.
boolean	impliedDecimalSeparator Indicates if there is a decimal point implied at a specified location
int	length Length of the data block (number of characters) if the record is set to a fixed length
int	lengthPos Identifies a data field in the record that defines the expected fixed length for this field
String	method Method name to call to apply such customization on DataField.
String	name Name of the field (optional)
char	paddingChar The char to pad with if the record is set to a fixed length
String	pattern Pattern that the formatter will use to transform the data (optional)
int	position Position of the field in the output message generated (should start from 1)
int	precision precision of the BigDecimal number to be created
boolean	required Indicates if the field is mandatory
String	rounding Round mode to be used to round/scale a BigDecimal Values : UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN,HALF_EVEN, UNNECESSARY e.g : Number = 123456.789, Precision = 2, Rounding = CEILING Result : 123456.79
String	timezone
boolean	trim Indicates if the value should be trimmed

Element Detail

pos

public abstract int pos

Position of the data in the input record, must start from 1 (mandatory).

name

public abstract String name

Name of the field (optional)

Default:

""

columnName

public abstract String columnName

Name of the header column (optional)

Default:

""

pattern

public abstract String pattern

Pattern that the formatter will use to transform the data (optional)

Default:

""

timezone

public abstract String timezone

Returns:

String timezone ID

Default:

""

length

public abstract int length

Length of the data block (number of characters) if the record is set to a fixed length

Default:

0

lengthPos

public abstract int lengthPos

Identifies a data field in the record that defines the expected fixed length for this field

Default:

0

align

public abstract String align

Align the text to the right or left. Use values R or L.

Default:

"R"

paddingChar

public abstract char paddingChar

The char to pad with if the record is set to a fixed length

Default:

32

precision

public abstract int precision

precision of the BigDecimal number to be created

Default:

0

position

public abstract int position

Position of the field in the output message generated (should start from 1)

See Also:

pos()

Default:

0

required

public abstract boolean required

Indicates if the field is mandatory

Default:

false

trim

public abstract boolean trim

Indicates if the value should be trimmed

Default:

false

clip

public abstract boolean clip

Indicates to clip data in the field if it exceeds the allowed length when using fixed length.

Default:

false

delimiter

public abstract String delimiter

Optional delimiter to be used if the field has a variable length

Default:

""

defaultValue

public abstract String defaultValue

Field's default value in case no value is set

Default:

""

impliedDecimalSeparator

public abstract boolean impliedDecimalSeparator

Indicates if there is a decimal point implied at a specified location

Default:

false

decimalSeparator

public abstract String decimalSeparator

Decimal Separator to be used with BigDecimal number

Default:

""

groupingSeparator

public abstract String groupingSeparator

Grouping Separator to be used with BigDecimal number when we would like to format/parse to number with grouping e.g. 123,456.789

Default:

""

rounding

public abstract String rounding

Round mode to be used to round/scale a BigDecimal Values : UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN,HALF_EVEN, UNNECESSARY e.g : Number = 123456.789, Precision = 2, Rounding = CEILING Result : 123456.79

Default:

"CEILING"

method

public abstract String method

Method name to call to apply such customization on DataField. This must be the method on the datafield itself or you must provide static fully qualified name of the class's method e.g: see unit test org.apache.camel.dataformat.bindy.csv.BindySimpleCsvFunctionWithExternalMethodTest.replaceToBar

Default:

""