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 2015/11/25 23:11:18 UTC

isis-site git commit: ISIS-1262: Persistable_downloadJdoMetadata

Repository: isis-site
Updated Branches:
  refs/heads/asf-site 2d3a7aabe -> 4861529ed


ISIS-1262: Persistable_downloadJdoMetadata


Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/4861529e
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/4861529e
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/4861529e

Branch: refs/heads/asf-site
Commit: 4861529ede0af52f7671501dc4c39a03e59b15ec
Parents: 2d3a7aa
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Wed Nov 25 22:10:54 2015 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Wed Nov 25 22:10:54 2015 +0000

----------------------------------------------------------------------
 content/documentation.html | 16 ++++++++++---
 content/guides/rg.html     | 50 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis-site/blob/4861529e/content/documentation.html
----------------------------------------------------------------------
diff --git a/content/documentation.html b/content/documentation.html
index 2dc88e3..2577b09 100644
--- a/content/documentation.html
+++ b/content/documentation.html
@@ -591,15 +591,15 @@ table.CodeRay td.code>pre{padding:0}
 </ul>
 </div>
 <div class="paragraph">
-<p><strong>Isis Add-ons</strong></p>
+<p><strong>3rd-party add-ons (not ASF)</strong></p>
 </div>
 <div class="ulist">
 <ul>
 <li>
-<p><a href="http://isisaddons.org">Isis addons</a> (not ASF)</p>
+<p><a href="http://isisaddons.org">Isis addons</a></p>
 </li>
 <li>
-<p><a href="https://github.com/isisaddons/isis-app-simpledsl/">isis-script DSL</a> (not ASF)</p>
+<p><a href="http://catalog.incode.org">Incode Catalog</a></p>
 </li>
 </ul>
 </div></div></td>
@@ -738,6 +738,13 @@ table.CodeRay td.code>pre{padding:0}
 <li>
 <p><a href="http://github.com/isisaddons/isis-app-quickstart">Quickstart</a></p>
 </li>
+</ul>
+</div>
+<div class="paragraph">
+<p>tools (not ASF):</p>
+</div>
+<div class="ulist">
+<ul>
 <li>
 <p><a href="http://github.com/isisaddons/isis-app-simpledsl">Isis DSL Example</a></p>
 </li>
@@ -757,6 +764,9 @@ table.CodeRay td.code>pre{padding:0}
 <li>
 <p><a href="./resources/thesis/Pawson-Naked-Objects-thesis.pdf">Naked Objects PhD thesis</a> (Pawson)</p>
 </li>
+<li>
+<p><a href="https://github.com/isisaddons/isis-app-simpledsl/">isis-script DSL</a></p>
+</li>
 </ul>
 </div></div></td>
 <td class="tableblock halign-left valign-top"><div><div class="paragraph">

http://git-wip-us.apache.org/repos/asf/isis-site/blob/4861529e/content/guides/rg.html
----------------------------------------------------------------------
diff --git a/content/guides/rg.html b/content/guides/rg.html
index 6d2ff81..f9105f3 100644
--- a/content/guides/rg.html
+++ b/content/guides/rg.html
@@ -23329,6 +23329,51 @@ referenced by the DTO).</p>
 </div>
 </div>
 </div>
+<div class="sect3">
+<h4 id="_rg_classes_mixins_Persistable">6.11.5. <code>Persistable</code> (<code>1.11.0-SNAPSHOT</code>)</h4>
+<div class="paragraph">
+<p>All domain entities automatically implement the DataNucleus <code>Persistable</code> role interface as a result of the enhancer
+process (the fully qualified class name is <code>org.datanucleus.enhancement.Persistable</code>).  So as a developer you do not
+need to write any code for this role interface.</p>
+</div>
+<div class="paragraph">
+<p>Nevertheless, the <code>Persistable_downloadJdoMetadata</code> mixin (<code>1.11.0-SNAPSHOT</code>) provides the ability to download the
+JDO <a href="http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html">class metadata in XML</a> form.  The mixin
+defines the following action:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Mixin</span>
+<span class="directive">public</span> <span class="type">class</span> <span class="class">Persistable_downloadJdoMetadata</span> {
+    <span class="directive">public</span> Persistable_downloadJdoMetadata(<span class="directive">final</span> Persistable persistable) { ... }   <i class="conum" data-value="1"></i><b>(1)</b>
+    <span class="directive">public</span> <span class="predefined-type">Object</span> downloadJdoMetadata(<span class="directive">final</span> <span class="predefined-type">String</span> fileName) { ... }                <i class="conum" data-value="2"></i><b>(2)</b>
+    ...
+}</code></pre>
+</div>
+</div>
+<div class="colist arabic">
+<table>
+<tr>
+<td><i class="conum" data-value="1"></i><b>1</b></td>
+<td>provided as an action to any domain entity</td>
+</tr>
+<tr>
+<td><i class="conum" data-value="2"></i><b>2</b></td>
+<td>actually this is '$$' in the code, a "special case" that means to use the derive the action name from the class name.</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>This will return the XML text wrapped up in a <a href="#_rg_classes_value-types_manpage-Clob"><code>Clob</code></a>.</p>
+</div>
+<div class="sect4">
+<h5 id="_related_services_24">Related Services</h5>
+<div class="paragraph">
+<p>The mixin delegates to the <a href="#_rg_services-api_manpage-IsisJdoSupport"><code>IsisJdoSupport</code></a> service to obtain
+a reference to the JDO <code>PersistenceManagerFactory</code>.</p>
+</div>
+</div>
+</div>
 </div>
 </div>
 </div>
@@ -27246,6 +27291,11 @@ the default ones of <code>isis.properties</code> et al):</p>
 <li><a href="#_related_services_23">Related Services</a></li>
 </ul>
 </li>
+<li><a href="#_rg_classes_mixins_Persistable">6.11.5. <code>Persistable</code> (<code>1.11.0-SNAPSHOT</code>)</a>
+<ul class="sectlevel4">
+<li><a href="#_related_services_24">Related Services</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>