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.


Required Element Summary
 int pos
          position of the data in the record (mandatory)
 
Optional Element Summary
 String align
          align the text to the RIGHT or to LEFT part
 String columnName
          name of the header column (optional)
 int length
          length of the data block (useful for the fixedlength record)
 String name
          name of the field (optional)
 char paddingChar
          The char to pad with.
 String pattern
          pattern that the formater will use to transform the data (optional)
 int position
          Position of the field in the message generated
 int precision
          precision of the BigDecimal number to be created
 boolean required
          Indicates if the field is mandatory
 boolean trim
          Indicates if the value should be trimed
 

Element Detail

pos

public abstract int pos
position of the data in the record (mandatory)

Returns:
int

name

public abstract String name
name of the field (optional)

Returns:
String
Default:
""

columnName

public abstract String columnName
name of the header column (optional)

Returns:
String
Default:
""

pattern

public abstract String pattern
pattern that the formater will use to transform the data (optional)

Returns:
String
Default:
""

length

public abstract int length
length of the data block (useful for the fixedlength record)

Returns:
int
Default:
0

align

public abstract String align
align the text to the RIGHT or to LEFT part

Returns:
String
Default:
"R"

paddingChar

public abstract char paddingChar
The char to pad with.

Returns:
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

Returns:
int
Default:
0

position

public abstract int position
Position of the field in the message generated

Returns:
int
Default:
0

required

public abstract boolean required
Indicates if the field is mandatory

Returns:
boolean
Default:
false

trim

public abstract boolean trim
Indicates if the value should be trimed

Returns:
boolean
Default:
false


Copyright © 2007-2010 The Apache Software Foundation. All Rights Reserved.