You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by bu...@apache.org on 2014/05/20 15:30:24 UTC
svn commit: r909418 - in /websites/staging/openjpa/trunk/content: ./
jest-syntax.html
Author: buildbot
Date: Tue May 20 13:30:23 2014
New Revision: 909418
Log:
Staging update by buildbot for openjpa
Modified:
websites/staging/openjpa/trunk/content/ (props changed)
websites/staging/openjpa/trunk/content/jest-syntax.html
Propchange: websites/staging/openjpa/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue May 20 13:30:23 2014
@@ -1 +1 @@
-1594980
+1596239
Modified: websites/staging/openjpa/trunk/content/jest-syntax.html
==============================================================================
--- websites/staging/openjpa/trunk/content/jest-syntax.html (original)
+++ websites/staging/openjpa/trunk/content/jest-syntax.html Tue May 20 13:30:23 2014
@@ -22,7 +22,7 @@ limitations under the License.
<!-- <link href="http://openjpa.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css"/> -->
<link href="./css/type-settings.css" rel="stylesheet" type="text/css"/>
<LINK rel="schema.DC" href="http://purl.org/DC/elements/1.0/">
- <META name="Description" content="Apache OpenJPA -- JEST Syntax
" />
+ <META name="Description" content="Apache OpenJPA -- JEST Syntax" />
<META name="Keywords" content="Apache OpenJPA, JPA, JPA 1.0, JSR-220, JPA2, JPA 2.0, JSR-317, " />
<META name="Owner" content="dev@openjpa.apache.org" />
<META name="Robots" content="index, follow" />
@@ -68,7 +68,7 @@ limitations under the License.
<div class="bottom_red_bar">
<div id="site-breadcrumbs">
<!-- Breadcrumbs --
- <a href="/">Home</a> » <a href="/jest-syntax.html">JEST Syntax
</a>
+ <a href="/">Home</a> » <a href="/jest-syntax.html">JEST Syntax</a>
-- Breadcrumbs -->
</div>
</div>
@@ -148,11 +148,11 @@ limitations under the License.
<p><a name="JESTSyntax-JESTURISyntax"></a></p>
<h2 id="jest-uri-syntax">JEST URI Syntax</h2>
<p>JEST defines URI syntax to access persistent resources over HTTP. </p>
-<p>For example, to find a persistent Person instance with primary key 1234 and
-receive the result in <em>JSON</em> format will be:</p>
+<p>As an example, to find a persistent Person instance with primary key 1234 and
+receive the result in <em>JSON</em> format, an example URI would look like this (non functional URI):</p>
<p><a href="http://www.example.com:8080/jest/find/format=json?type=Person&1234">http://www.example.com:8080/jest/find/format=json?type=Person&1234</a></p>
<p>The formal notation of a JEST URI is</p>
-<div class="codehilite"><pre> <span class="n">URI</span> <span class="p">:</span><span class="o">=</span> <span class="n">http:</span><span class="sr">//</span><span class="p">{</span><span class="n">host</span><span class="p">}[:</span><span class="n">port</span><span class="p">]</span><span class="sr">/{context}/</span><span class="p">{</span><span class="n">action</span><span class="p">}[</span><span class="o">/</span><span class="n">qualifier</span><span class="p">]</span><span class="o">*</span> <span class="p">[?</span><span class="n">argument</span><span class="p">]</span> <span class="p">[</span><span class="o">&</span><span class="n">argument</span><span class="p">]</span><span class="o">*</span>
+<div class="codehilite"><pre> <span class="n">URI</span> <span class="p">:=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="p">{</span><span class="n">host</span><span class="p">}[:</span><span class="n">port</span><span class="p">]</span><span class="o">/</span><span class="p">{</span><span class="n">context</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">action</span><span class="p">}[</span><span class="o">/</span><span class="n">qualifier</span><span class="p">]</span><span class="o">*</span> <span class="p">[</span>?<span class="n">argument</span><span class="p">]</span> <span class="p">[</span><span class="o">&</span><span class="n">argument</span><span class="p">]</span><span class="o">*</span>
</pre></div>
@@ -215,8 +215,7 @@ corresponding qualifiers and arguments.
A <strong>bold font</strong> denotes qualifier or argument as mandatory.</p>
<p><a name="JESTSyntax-Action:find"></a></p>
<h3 id="action-find">Action: find</h3>
-<p>Returns the result of a <em>find()</em> operation.<br />
-</p>
+<p>Returns the result of a <em>find()</em> operation. </p>
<table>
<tr><th>qualifier-key </th><th> qualifier-value</th><th> Comment</th></tr>
<tr><td class="border">format </td><td class="border"> <tt>xml</tt> or <tt>json</tt> </td><td class="border"> default is <tt>xml</tt></td></tr>
@@ -243,8 +242,7 @@ without the id property name</td></tr>
<p><a name="JESTSyntax-Action:query"></a></p>
<h3 id="action-query">Action : query</h3>
<p>Returns the result of a <code>Query.getResultList()</code> or
-<code>Query.getSingleResult()</code> operation. <br />
-</p>
+<code>Query.getSingleResult()</code> operation. </p>
<table>
<tr><th>qualifier-key </th><th> qualifier-value</th><th> Comment</th></tr>
<tr><td class="border">format </td><td class="border"> <tt>xml</tt> or <tt>json</tt> </td><td class="border"> default is <tt>xml</tt></td></tr>
@@ -287,16 +285,16 @@ Accepts no argument. </p>
Accepts no argument. </p>
<p><a name="JESTSyntax-Formalsyntax:"></a></p>
<h3 id="formal-syntax">Formal syntax:</h3>
-<div class="codehilite"><pre><span class="n">URI</span> <span class="p">:</span><span class="o">=</span> <span class="n">http:</span><span class="sr">//</span><span class="p">{</span><span class="n">host</span><span class="p">}[:</span><span class="n">port</span><span class="p">]</span><span class="sr">/{context}/</span><span class="p">{</span><span class="n">action</span><span class="p">}[</span><span class="o">/</span><span class="n">qualifier</span><span class="p">]</span><span class="o">*</span> <span class="p">[?</span><span class="n">argument</span><span class="p">][</span><span class="o">&</span><span class="n">argument</span><span class="p">]</span><span class="o">*</span>
+<div class="codehilite"><pre><span class="n">URI</span> <span class="p">:=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="p">{</span><span class="n">host</span><span class="p">}[:</span><span class="n">port</span><span class="p">]</span><span class="o">/</span><span class="p">{</span><span class="n">context</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">action</span><span class="p">}[</span><span class="o">/</span><span class="n">qualifier</span><span class="p">]</span><span class="o">*</span> <span class="p">[</span>?<span class="n">argument</span><span class="p">][</span><span class="o">&</span><span class="n">argument</span><span class="p">]</span><span class="o">*</span>
-<span class="n">context</span> <span class="p">:</span><span class="o">=</span> <span class="n">JEST</span> <span class="n">servlet</span> <span class="n">context</span> <span class="n">root</span>
-<span class="n">action</span> <span class="p">:</span><span class="o">=</span> <span class="n">find</span><span class="o">|</span><span class="n">query</span><span class="o">|</span><span class="n">domain</span><span class="o">|</span><span class="n">properties</span>
-<span class="n">qualifier</span> <span class="p">:</span><span class="o">=</span> <span class="n">qualifier</span><span class="o">-</span><span class="n">key</span><span class="p">[</span><span class="o">=</span><span class="n">qualifier</span><span class="o">-</span><span class="n">value</span><span class="p">]</span>
-<span class="n">argument</span> <span class="p">:</span><span class="o">=</span> <span class="p">[</span><span class="n">argument</span><span class="o">-</span><span class="n">key</span><span class="o">=</span><span class="p">]</span> <span class="n">argument</span><span class="o">-</span><span class="n">value</span>
-<span class="n">qualifier</span><span class="o">-</span><span class="n">key</span> <span class="p">:</span><span class="o">=</span> <span class="n">any</span> <span class="n">valid</span> <span class="n">Java</span> <span class="n">identifier</span>
-<span class="n">qualifier</span><span class="o">-</span><span class="n">value</span> <span class="p">:</span><span class="o">=</span> <span class="n">string</span>
-<span class="n">argument</span><span class="o">-</span><span class="n">key</span> <span class="p">:</span><span class="o">=</span> <span class="n">string</span>
-<span class="n">argument</span><span class="o">-</span><span class="n">value</span> <span class="p">:</span><span class="o">=</span> <span class="n">string</span>
+<span class="n">context</span> <span class="p">:=</span> <span class="n">JEST</span> <span class="n">servlet</span> <span class="n">context</span> <span class="n">root</span>
+<span class="n">action</span> <span class="p">:=</span> <span class="nb">find</span><span class="o">|</span><span class="n">query</span><span class="o">|</span><span class="n">domain</span><span class="o">|</span><span class="k">properties</span>
+<span class="n">qualifier</span> <span class="p">:=</span> <span class="n">qualifier</span><span class="o">-</span><span class="n">key</span><span class="p">[=</span><span class="n">qualifier</span><span class="o">-</span><span class="n">value</span><span class="p">]</span>
+<span class="n">argument</span> <span class="p">:=</span> <span class="p">[</span><span class="n">argument</span><span class="o">-</span><span class="n">key</span><span class="p">=]</span> <span class="n">argument</span><span class="o">-</span><span class="n">value</span>
+<span class="n">qualifier</span><span class="o">-</span><span class="n">key</span> <span class="p">:=</span> <span class="n">any</span> <span class="n">valid</span> <span class="n">Java</span> <span class="n">identifier</span>
+<span class="n">qualifier</span><span class="o">-</span><span class="n">value</span> <span class="p">:=</span> <span class="n">string</span>
+<span class="n">argument</span><span class="o">-</span><span class="n">key</span> <span class="p">:=</span> <span class="n">string</span>
+<span class="n">argument</span><span class="o">-</span><span class="n">value</span> <span class="p">:=</span> <span class="n">string</span>
</pre></div>
</div>
</td>