updated docu

Author: Mark

docs/aql.md

@@ -24,8 +24,8 @@ E.g. get all Simpsons aged 3 or older in ascending order:
   ArangoCursor<MyObject> cursor = db.query(query, bindVars, null, MyObject.class);
 
   cursor.forEachRemaining(obj -> {
-	  System.out.println(obj.getName());
-	});
+    System.out.println(obj.getName());
+  });
 ```
 
 or return the AQL result as VelocyPack:
@@ -34,6 +34,6 @@ or return the AQL result as VelocyPack:
   ArangoCursor<VPackSlice> cursor = db.query(query, bindVars, null, VPackSlice.class);
 
   cursor.forEachRemaining(obj -> {
-	  System.out.println(obj.get("name").getAsString());
-	});
+    System.out.println(obj.get("name").getAsString());
+  });
 ```

docs/documentation.md

@@ -1,6 +1,9 @@
+#Documentation overview
+
 * [Driver Setup](setup.md)
 * [Basic database operations](basic_operations.md)
 * [Multi document operations](multi_operations.md)
+* [serialization/deserialization](serialization.md)
 * [User Management](user_management.md)
 * [AQL](aql.md)
 * [Graphs](graphs.md)

docs/serialization.md

@@ -0,0 +1,75 @@
+# serialization / deserialization
+## JavaBeans
+The driver can serialize/deserialize JavaBeans. They need at least a constructor without parameter.
+
+``` Java
+  public class MyObject {
+
+    private String name;
+    private Gender gender;
+    private int age;
+
+    public MyObject() {
+      super();
+    }
+
+  }  
+```
+
+## internal fields
+To use Arango-internal fields (like _id, _key, _rev, _from, _to) in your JavaBeans, use the annotation `DocumentField`.
+
+``` Java
+  public class MyObject {
+
+    @DocumentField(Type.KEY)
+    private String key;
+    
+    private String name;
+    private Gender gender;
+    private int age;
+
+    public MyObject() {
+      super();
+    }
+
+  }  
+```
+
+## serialized fieldnames
+To use a different serialized name for a field, use the annotation `SerializedName`.
+
+``` Java
+  public class MyObject {
+
+    @SerializedName("title")
+    private String name;
+    
+    private Gender gender;
+    private int age;
+
+    public MyObject() {
+      super();
+    }
+
+  }  
+```
+
+## ignore fields
+To ignore fields at serialization/deserialization, use the annotation `Expose`
+
+``` Java
+  public class MyObject {
+
+    @Expose
+    private String name;
+    @Expose(serialize = true, deserialize = false)
+    private Gender gender;
+    private int age;
+
+    public MyObject() {
+      super();
+    }
+
+  }  
+```

docs/setup.md

@@ -12,15 +12,15 @@ Setup with default configuration, this automatically loads a properties file ara
 The driver is configured with some default values:
 
 <table>
-<tr><th>property-key</th><th>description</th><th>default value</th></tr>
-<tr><td>arangodb.host</td><td>ArangoDB host</td><td>127.0.0.1</td></tr>
-<tr><td>arangodb.port</td><td>ArangoDB port</td><td>8529</td></tr>
-<tr><td>arangodb.timeout</td><td>socket connect timeout(millisecond)</td><td>0</td></tr>
-<tr><td>arangodb.user</td><td>Basic Authentication User</td><td></td></tr>
-<tr><td>arangodb.password</td><td>Basic Authentication Password</td><td></td></tr>
-<tr><td>arangodb.useSsl</td><td>use SSL connection</td><td>false</td></tr>
-<tr><td>harangodb.chunksize</td><td>VelocyStream Chunk content-size(bytes)</td><td>30000</td></tr>
-</table>
+<tr><th>property-key<  h><th>description<  h><th>default value<  h><  r>
+<tr><td>arangodb.host<  d><td>ArangoDB host<  d><td>127.0.0.1<  d><  r>
+<tr><td>arangodb.port<  d><td>ArangoDB port<  d><td>8529<  d><  r>
+<tr><td>arangodb.timeout<  d><td>socket connect timeout(millisecond)<  d><td>0<  d><  r>
+<tr><td>arangodb.user<  d><td>Basic Authentication User<  d><td><  d><  r>
+<tr><td>arangodb.password<  d><td>Basic Authentication Password<  d><td><  d><  r>
+<tr><td>arangodb.useSsl<  d><td>use SSL connection<  d><td>false<  d><  r>
+<tr><td>harangodb.chunksize<  d><td>VelocyStream Chunk content-size(bytes)<  d><td>30000<  d><  r>
+<  able>
 
 To customize the configuration the parameters can be changed in the code...