OGM-717 Updating reference documentation

hibernate · May 14, 2015 · 52559fc · 52559fc
1 parent 25c4f44
commit 52559fc
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 5 deletions.
diff --git a/documentation/manual/src/main/asciidoc/en-US/modules/couchdb.asciidoc b/documentation/manual/src/main/asciidoc/en-US/modules/couchdb.asciidoc
@@ -209,7 +209,10 @@ Hibernate OGM support by default the following types:
 
 [source, JSON]
 ----
-  { "favorite" : true }
+  { "favorite" : true } # default mapping
+  { "favorite" : "T" } # if @Type(type = "true_false") is given
+  { "favorite" : "Y" } # if @Type(type = "yes_no") is given
+  { "favorite" : 1 } # if @Type(type = "numeric_boolean") is given
 ----
 
 * [classname]+java.lang.Byte+ (or byte primitive)

diff --git a/documentation/manual/src/main/asciidoc/en-US/modules/ehcache.asciidoc b/documentation/manual/src/main/asciidoc/en-US/modules/ehcache.asciidoc
@@ -125,7 +125,7 @@ Hibernate OGM supports by default the following property types:
 
 * [classname]+java.lang.String+
 * [classname]+java.lang.Character+ (or char primitive)
-* [classname]+java.lang.Boolean+ (or boolean primitive)
+* [classname]+java.lang.Boolean+ (or boolean primitive); Optionally the annotations +@Type(type = "true_false")+, @Type(type = "yes_no") and @Type(type = "numeric_boolean") can be used to map boolean properties to the characters 'T'/'F', 'Y'/'N' or the int values 0/1, respectively.
 * [classname]+java.lang.Byte+ (or byte primitive)
 * [classname]+java.lang.Short+ (or short primitive)
 * [classname]+java.lang.Integer+ (or integer primitive)

diff --git a/documentation/manual/src/main/asciidoc/en-US/modules/infinispan.asciidoc b/documentation/manual/src/main/asciidoc/en-US/modules/infinispan.asciidoc
@@ -420,7 +420,7 @@ Hibernate OGM support by default the following property types:
 
 * [classname]+java.lang.String+
 * [classname]+java.lang.Character+ (or char primitive)
-* [classname]+java.lang.Boolean+ (or boolean primitive)
+* [classname]+java.lang.Boolean+ (or boolean primitive); Optionally the annotations +@Type(type = "true_false")+, @Type(type = "yes_no") and @Type(type = "numeric_boolean") can be used to map boolean properties to the characters 'T'/'F', 'Y'/'N' or the int values 0/1, respectively.
 * [classname]+java.lang.Byte+ (or byte primitive)
 * [classname]+java.lang.Short+ (or short primitive)
 * [classname]+java.lang.Integer+ (or integer primitive)

diff --git a/documentation/manual/src/main/asciidoc/en-US/modules/mongodb.asciidoc b/documentation/manual/src/main/asciidoc/en-US/modules/mongodb.asciidoc
@@ -349,7 +349,10 @@ Hibernate OGM supports by default the following property types:
 
 [source, JSON]
 ----
-  { "favorite" : true }
+  { "favorite" : true } # default mapping
+  { "favorite" : "T" } # if @Type(type = "true_false") is given
+  { "favorite" : "Y" } # if @Type(type = "yes_no") is given
+  { "favorite" : 1 } # if @Type(type = "numeric_boolean") is given
 ----
 
 * [classname]+java.lang.Byte+ (or byte primitive)

diff --git a/documentation/manual/src/main/asciidoc/en-US/modules/neo4j.asciidoc b/documentation/manual/src/main/asciidoc/en-US/modules/neo4j.asciidoc
@@ -104,7 +104,7 @@ Each property or more precisely column is represented by an attribute of this no
 
 The following types (and corresponding primitives) get passed to Neo4j without any conversion:
 
-* [classname]+java.lang.Boolean+
+* [classname]+java.lang.Boolean+; Optionally the annotations +@Type(type = "true_false")+, @Type(type = "yes_no") and @Type(type = "numeric_boolean") can be used to map boolean properties to the characters 'T'/'F', 'Y'/'N' or the int values 0/1, respectively.
 * [classname]+java.lang.Character+
 * [classname]+java.lang.Byte+
 * [classname]+java.lang.Short+