This is an automated email from the ASF dual-hosted git repository.
tsato pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 52152cb CAMEL-16517 - Updating camel-bindy dataformat doc
52152cb is described below
commit 52152cb35b62f00881b4904f65d9e1bdc3eb0d8b
Author: Tadayoshi Sato <[email protected]>
AuthorDate: Fri Apr 30 17:44:32 2021 +0900
CAMEL-16517 - Updating camel-bindy dataformat doc
---
.../src/main/docs/bindy-dataformat.adoc | 42 +++++++++++-----------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
index 9273669..3a41560 100644
--- a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
+++ b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
@@ -29,18 +29,18 @@ property.
For the BigDecimal numbers, you can also define the precision and the
decimal or grouping separators.
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%m,10%m,70%",options="header",]
|===
|Type |Format Type |Pattern example |Link
-|Date |DateFormat |`dd-MM-yyyy`
|http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html[http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html]
+|Date |DateFormat |dd-MM-yyyy
|https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
-|Decimal* |Decimalformat |`##.###.###`
|http://java.sun.com/j2se/1.5.0/docs/api/java/text/DecimalFormat.html[http://java.sun.com/j2se/1.5.0/docs/api/java/text/DecimalFormat.html]
+|Decimal* |DecimalFormat |+##.###.###+
|https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html
|===
-Decimal* = Double, Integer, Float, Short, Long
+*Decimal = Double, Integer, Float, Short, Long
- *Format supported*
+*Format supported*
This first release only support comma separated values fields and key
value pair fields (e.g. : FIX messages).
@@ -50,7 +50,7 @@ To work with camel-bindy, you must first define your model in
a package
Instrument, ...) add the required annotations (described hereafter) to
the Class or field.
- *Multiple models*
+*Multiple models*
As you configure bindy using class names instead of package names
you can put multiple models in the same package.
@@ -78,7 +78,7 @@ The Bindy dataformat supports 5 options, which are listed
below.
== Annotations
The annotations created allow to map different concept of your model to
-the POJO like :
+the POJO like:
* Type of record (csv, key value pair (e.g. FIX message), fixed length
...),
@@ -91,19 +91,19 @@ financial messages),
* BindyConverter,
* FormatFactories
-This section will describe them :
+This section will describe them.
-== 1. CsvRecord
+=== 1. CsvRecord
The CsvRecord annotation is used to identified the root class of the
-model. It represents a record = a line of a CSV file and can be linked
+model. It represents a record = "a line of a CSV file" and can be linked
to several children model classes.
-[width="100%",cols="10%,10%,80%",options="header",]
+[width="100%",cols="10%s,10%,80%",options="header",]
|===
|Annotation name |Record type |Level
-|*CsvRecord* |csv |Class
+|CsvRecord |csv |Class
|===
[width="100%",cols="10%,10%,80%",options="header",]
@@ -346,7 +346,7 @@ public Class Order {
Remark : pos is used to parse the file, stream while positions is used
to generate the CSV
-== 2. Link
+=== 2. Link
The link annotation will allow to link objects together.
@@ -398,7 +398,7 @@ public class Client {
}
----
-== 3. DataField
+=== 3. DataField
The DataField annotation defines the property of the field. Each
datafield is identified by its position in the record, a type (string,
@@ -716,7 +716,7 @@ public class Order {
This attribute is only applicable to optional fields.
-== 4. FixedLengthRecord
+=== 4. FixedLengthRecord
The FixedLengthRecord annotation is used to identified the root class of
the model. It represents a record = a line of a file/message containing
@@ -1159,7 +1159,7 @@ public static class Order {
}
----
-== 5. Message
+=== 5. Message
The Message annotation is used to identified the class of your model who
will contain key value pairs fields. This kind of format is used mainly
@@ -1240,7 +1240,7 @@ message looks like (src\test\data\fix\fix.txt) and the
Order, Trailer,
Header classes
(src\test\java\org\apache\camel\dataformat\bindy\model\fix\simple\Order.java)
-== 6. KeyValuePairField
+=== 6. KeyValuePairField
The KeyValuePairField annotation defines the property of a key value
pair field. Each KeyValuePairField is identified by a tag (= key) and
@@ -1336,7 +1336,7 @@ public class Order {
}
----
-== 7. Section
+=== 7. Section
In FIX message of fixed length records, it is common to have different
sections in the representation of the information : header, body and
@@ -1418,7 +1418,7 @@ public class Trailer {
}
----
-== 8. OneToMany
+=== 8. OneToMany
The purpose of the annotation @OneToMany is to allow to work with a
`List<?>` field defined a POJO class or from a record containing
@@ -1552,7 +1552,7 @@ public class Security {
}
----
-== 9. BindyConverter
+=== 9. BindyConverter
The purpose of the annotation @BindyConverter is define a converter
to be used on field level. The provided class must implement the
@@ -1580,7 +1580,7 @@ public static class CustomConverter implements
Format<String> {
}
----
-== 10. FormatFactories
+=== 10. FormatFactories
The purpose of the annotation @FormatFactories is to define a set of converters
at record-level. The provided classes must implement the
FormatFactoryInterface interface.
