You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/07/31 10:13:42 UTC
[isis] 01/05: ISIS-2222: updates some descriptions
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2222
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 13093425f552c1501a654a73d9ec699bc176bf8c
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jul 29 18:45:38 2020 +0100
ISIS-2222: updates some descriptions
---
.../demoapp/dom/types/isis/blobs/jdo/IsisBlobJdo-description.adoc | 3 ++-
.../demoapp/dom/types/isis/clobs/jdo/IsisClobJdo-description.adoc | 4 +++-
.../src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo.java | 6 +++---
.../demoapp/dom/types/isis/images/jdo/IsisImageJdo-description.adoc | 2 ++
.../jdo/IsisLocalResourcePathJdo-description.adoc | 5 ++++-
.../dom/types/isis/markups/jdo/IsisMarkupJdo-description.adoc | 5 ++++-
6 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/blobs/jdo/IsisBlobJdo-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/blobs/jdo/IsisBlobJdo-description.adoc
index c3dba0c..a304a75 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/blobs/jdo/IsisBlobJdo-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/blobs/jdo/IsisBlobJdo-description.adoc
@@ -1,4 +1,5 @@
-JDO supports `Blob` out-of-the-box, so no special annotations are required.
+Apache Isis implements the relevant JDO extension points to allow the `Blob` type to be persisted.
+To do so correctly, it requires that the column names for the three constituent parts of a `Blob` are specified using `@Column`:
[source,java]
----
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo-description.adoc
index 036cbc6..4ebc254 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo-description.adoc
@@ -1,4 +1,6 @@
-JDO supports `Clob` out-of-the-box, so no special annotations are required.
+Apache Isis implements the relevant JDO extension points to allow the `Clob` type to be persisted.
+To do so correctly, it requires that the column names for the three constituent parts of a `Clob` are specified using `@Column`.
+It's also necessary to specify the `jdbcType` to hold the characters:
[source,java]
----
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo.java b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo.java
index fb997b1..0c03002 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/clobs/jdo/IsisClobJdo.java
@@ -60,7 +60,7 @@ public class IsisClobJdo // <.>
@Persistent(defaultFetchGroup="false", columns = { // <.>
@Column(name = "readOnlyProperty_name"),
@Column(name = "readOnlyProperty_mimetype"),
- @Column(name = "readOnlyProperty_bytes"
+ @Column(name = "readOnlyProperty_chars"
, jdbcType = "CLOB"
)
})
@@ -72,7 +72,7 @@ public class IsisClobJdo // <.>
@Persistent(defaultFetchGroup="false", columns = {
@Column(name = "readWriteProperty_name"),
@Column(name = "readWriteProperty_mimetype"),
- @Column(name = "readWriteProperty_bytes"
+ @Column(name = "readWriteProperty_chars"
, jdbcType = "CLOB"
)
})
@@ -86,7 +86,7 @@ public class IsisClobJdo // <.>
allowsNull = "true"), // <.>
@Column(name = "readOnlyOptionalProperty_mimetype",
allowsNull = "true"),
- @Column(name = "readOnlyOptionalProperty_bytes"
+ @Column(name = "readOnlyOptionalProperty_chars"
, jdbcType = "CLOB"
, allowsNull = "true")
})
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/images/jdo/IsisImageJdo-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/images/jdo/IsisImageJdo-description.adoc
index 239088a..3e92044 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/images/jdo/IsisImageJdo-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/images/jdo/IsisImageJdo-description.adoc
@@ -1,3 +1,5 @@
+CAUTION: TODO - these notes may be incorrect.
+
JDO supports `Image` out-of-the-box, so no special annotations are required.
[source,java]
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/localresourcepaths/jdo/IsisLocalResourcePathJdo-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/localresourcepaths/jdo/IsisLocalResourcePathJdo-description.adoc
index 614e038..46a5ce3 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/localresourcepaths/jdo/IsisLocalResourcePathJdo-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/localresourcepaths/jdo/IsisLocalResourcePathJdo-description.adoc
@@ -1,4 +1,7 @@
-JDO supports `LocalResourcePath` out-of-the-box, so no special annotations are required.
+Apache Isis implements the relevant JDO extension points to allow the `LocalResourcePath` type to be persisted.
+No special annotations are required, though `@Column` can be used to fine-tune the mapping.
+The most common usage is to indicate whether the column can be null.
+Since the column ultimately maps down to a string, the column's length could also be specified:
[source,java]
----
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/markups/jdo/IsisMarkupJdo-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/markups/jdo/IsisMarkupJdo-description.adoc
index ff2b26b..8560c1a 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/types/isis/markups/jdo/IsisMarkupJdo-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/types/isis/markups/jdo/IsisMarkupJdo-description.adoc
@@ -1,4 +1,7 @@
-JDO supports `Markup` out-of-the-box, so no special annotations are required.
+Apache Isis implements the relevant JDO extension points to allow the `Markup` type to be persisted.
+No special annotations are required, though `@Column` can be used to fine-tune the mapping.
+The most common usage is to indicate whether the column can be null.
+Since the column ultimately maps down to a long string, the `jdbcType` should also be specified:
[source,java]
----