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 2016/06/16 17:58:22 UTC

[10/12] isis-site git commit: ISIS-1446: adds fileAccept attribute for @Property and @Parameter

http://git-wip-us.apache.org/repos/asf/isis-site/blob/1051ae80/content/guides/rgcms.html
----------------------------------------------------------------------
diff --git a/content/guides/rgcms.html b/content/guides/rgcms.html
index 35b43b0..dcc8010 100644
--- a/content/guides/rgcms.html
+++ b/content/guides/rgcms.html
@@ -4605,14 +4605,65 @@ TODO
 </table>
 <div class="sect3">
 <h4 id="_rgcms_classes_value-types_Blob">3.6.1. <code>Blob</code></h4>
-<div class="admonitionblock note">
+<div class="paragraph">
+<p><code>Blob</code> (in the <code>org.apache.isis.applib.value</code> package) is a value type defined by the Apache Isis framework to
+represent a binary large object.  Conceptually you can consider it as a set of bytes (a picture, a video etc), though
+in fact it wraps three pieces of information:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the set of bytes</p>
+</li>
+<li>
+<p>a name</p>
+</li>
+<li>
+<p>a mime type.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>This is reflected in the class' constructors and properties:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="directive">final</span> <span class="type">class</span> <span class="class">Blob</span> ... {
+    ...
+    public <span class="predefined-type">Blob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> primaryType, <span class="predefined-type">String</span> subtype, <span class="type">byte</span><span class="type">[]</span> bytes) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Blob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> mimeTypeBase, <span class="type">byte</span><span class="type">[]</span> bytes) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Blob</span>(<span class="predefined-type">String</span> name, MimeType mimeType, <span class="type">byte</span><span class="type">[]</span> bytes) { ... }
+    ...
+    public <span class="predefined-type">String</span> getName() { ... }
+    <span class="directive">public</span> MimeType getMimeType() { ... }
+    <span class="directive">public</span> <span class="type">byte</span><span class="type">[]</span> getBytes() { ... }
+    ...
+}</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Properties of this type can be mapped to JDO/DataNucleus using:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@javax</span>.jdo.annotations.Persistent(defaultFetchGroup=<span class="string"><span class="delimiter">&quot;</span><span class="content">false</span><span class="delimiter">&quot;</span></span>, columns = {
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someImage_name</span><span class="delimiter">&quot;</span></span>),
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someImage_mimetype</span><span class="delimiter">&quot;</span></span>),
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someImage_bytes</span><span class="delimiter">&quot;</span></span>, jdbcType = <span class="string"><span class="delimiter">&quot;</span><span class="content">BLOB</span><span class="delimiter">&quot;</span></span>, sqlType = <span class="string"><span class="delimiter">&quot;</span><span class="content">LONGVARBINARY</span><span class="delimiter">&quot;</span></span>)
+})
+<span class="directive">private</span> <span class="predefined-type">Blob</span> someImage;</code></pre>
+</div>
+</div>
+<div class="admonitionblock tip">
 <table>
 <tr>
 <td class="icon">
-<i class="fa icon-note" title="Note"></i>
+<i class="fa icon-tip" title="Tip"></i>
 </td>
 <td class="content">
-TODO - the <code>org.apache.isis.applib.value.Blob</code> class.
+<div class="paragraph">
+<p>For character large objects, use <a href="#_rgcms_classes_value-types_Clob]"><code>Clob</code></a> value type.</p>
+</div>
 </td>
 </tr>
 </table>
@@ -4620,14 +4671,68 @@ TODO - the <code>org.apache.isis.applib.value.Blob</code> class.
 </div>
 <div class="sect3">
 <h4 id="_rgcms_classes_value-types_Clob">3.6.2. <code>Clob</code></h4>
-<div class="admonitionblock note">
+<div class="paragraph">
+<p><code>Clob</code> (in the <code>org.apache.isis.applib.value</code> package) is a value type defined by the Apache Isis framework to
+represent a character large object.  Conceptually you can consider it as a set of characters (an RTF or XML document,
+for example), though in fact it wraps three pieces of information:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the set of characters</p>
+</li>
+<li>
+<p>a name</p>
+</li>
+<li>
+<p>a mime type.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>This is reflected in the class' constructors and properties:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="directive">final</span> <span class="type">class</span> <span class="class">Clob</span> ... {
+    ...
+    public <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> primaryType, <span class="predefined-type">String</span> subType, <span class="type">char</span><span class="type">[]</span> chars) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> mimeTypeBase, <span class="type">char</span><span class="type">[]</span> chars) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, MimeType mimeType, <span class="type">char</span><span class="type">[]</span> chars) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> primaryType, <span class="predefined-type">String</span> subType, <span class="predefined-type">CharSequence</span> chars) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, <span class="predefined-type">String</span> mimeTypeBase, <span class="predefined-type">CharSequence</span> chars) { ... }
+    <span class="directive">public</span> <span class="predefined-type">Clob</span>(<span class="predefined-type">String</span> name, MimeType mimeType, <span class="predefined-type">CharSequence</span> chars) { ... }
+    ...
+    public <span class="predefined-type">String</span> getName() { ... }
+    <span class="directive">public</span> MimeType getMimeType() { ... }
+    <span class="directive">public</span> <span class="predefined-type">CharSequence</span> getChars() { ... }
+    ...
+}</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Properties of this type can be mapped to JDO/DataNucleus using:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@javax</span>.jdo.annotations.Persistent(defaultFetchGroup=<span class="string"><span class="delimiter">&quot;</span><span class="content">false</span><span class="delimiter">&quot;</span></span>, columns = {
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someClob_name</span><span class="delimiter">&quot;</span></span>),
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someClob_mimetype</span><span class="delimiter">&quot;</span></span>),
+        <span class="annotation">@javax</span>.jdo.annotations.Column(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">someClob_chars</span><span class="delimiter">&quot;</span></span>, jdbcType = <span class="string"><span class="delimiter">&quot;</span><span class="content">CLOB</span><span class="delimiter">&quot;</span></span>, sqlType = <span class="string"><span class="delimiter">&quot;</span><span class="content">LONGVARCHAR</span><span class="delimiter">&quot;</span></span>)
+})
+<span class="directive">private</span> <span class="predefined-type">Clob</span> someClob;</code></pre>
+</div>
+</div>
+<div class="admonitionblock tip">
 <table>
 <tr>
 <td class="icon">
-<i class="fa icon-note" title="Note"></i>
+<i class="fa icon-tip" title="Tip"></i>
 </td>
 <td class="content">
-TODO - the <code>org.apache.isis.applib.value.Clob</code> class.
+<div class="paragraph">
+<p>For binary large objects, use <a href="#_rgcms_classes_value-types_Blob]"><code>Blob</code></a> value type.</p>
+</div>
 </td>
 </tr>
 </table>