You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by bu...@apache.org on 2015/08/04 14:18:32 UTC
svn commit: r960757 - in /websites/staging/olingo/trunk/content: ./
doc/odata4/tutorials/readep/tutorial_readep.html
Author: buildbot
Date: Tue Aug 4 12:18:32 2015
New Revision: 960757
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/odata4/tutorials/readep/tutorial_readep.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Aug 4 12:18:32 2015
@@ -1 +1 @@
-1694041
+1694042
Modified: websites/staging/olingo/trunk/content/doc/odata4/tutorials/readep/tutorial_readep.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/tutorials/readep/tutorial_readep.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/tutorials/readep/tutorial_readep.html Tue Aug 4 12:18:32 2015
@@ -735,48 +735,48 @@ This can be realized by implementing the
<span class="c1">// 1.2. retrieve the requested (Edm) property</span>
<span class="c1">// the last segment is the Property</span>
- <span class="n">UriResourceProperty</span> <span class="n">uriProperty</span> <span class="o">=</span> <span class="o">(</span><span class="n">UriResourceProperty</span><span class="o">)</span> <span class="n">resourceParts</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="n">resourceParts</span><span class="o">.</span><span class="na">size</span><span class="o">()</span> <span class="o">-</span><span class="mi">1</span><span class="o">);</span>
- <span class="n">EdmProperty</span> <span class="n">edmProperty</span> <span class="o">=</span> <span class="n">uriProperty</span><span class="o">.</span><span class="na">getProperty</span><span class="o">();</span>
- <span class="n">String</span> <span class="n">edmPropertyName</span> <span class="o">=</span> <span class="n">edmProperty</span><span class="o">.</span><span class="na">getName</span><span class="o">();</span>
- <span class="c1">// in our example, we know we have only primitive types in our model</span>
- <span class="n">EdmPrimitiveType</span> <span class="n">edmPropertyType</span> <span class="o">=</span> <span class="o">(</span><span class="n">EdmPrimitiveType</span><span class="o">)</span> <span class="n">edmProperty</span><span class="o">.</span><span class="na">getType</span><span class="o">();</span>
-
- <span class="c1">// 2. retrieve data from backend</span>
- <span class="c1">// 2.1. retrieve the entity data, for which the property has to be read</span>
- <span class="n">Entity</span> <span class="n">entity</span> <span class="o">=</span> <span class="n">storage</span><span class="o">.</span><span class="na">readEntityData</span><span class="o">(</span><span class="n">edmEntitySet</span><span class="o">,</span> <span class="n">keyPredicates</span><span class="o">);</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">entity</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span> <span class="c1">// Bad request</span>
- <span class="k">throw</span> <span class="k">new</span> <span class="nf">ODataApplicationException</span><span class="o">(</span><span class="s">"Entity not found"</span><span class="o">,</span>
- <span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NOT_FOUND</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">(),</span> <span class="n">Locale</span><span class="o">.</span><span class="na">ENGLISH</span><span class="o">);</span>
- <span class="o">}</span>
-
- <span class="c1">// 2.2. retrieve the property data from the entity</span>
- <span class="n">Property</span> <span class="n">property</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">edmPropertyName</span><span class="o">);</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">property</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
- <span class="k">throw</span> <span class="k">new</span> <span class="nf">ODataApplicationException</span><span class="o">(</span><span class="s">"Property not found"</span><span class="o">,</span>
- <span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NOT_FOUND</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">(),</span> <span class="n">Locale</span><span class="o">.</span><span class="na">ENGLISH</span><span class="o">);</span>
- <span class="o">}</span>
-
- <span class="c1">// 3. serialize</span>
- <span class="n">Object</span> <span class="n">value</span> <span class="o">=</span> <span class="n">property</span><span class="o">.</span><span class="na">getValue</span><span class="o">();</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">value</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
- <span class="c1">// 3.1. configure the serializer</span>
- <span class="n">ODataFormat</span> <span class="n">format</span> <span class="o">=</span> <span class="n">ODataFormat</span><span class="o">.</span><span class="na">fromContentType</span><span class="o">(</span><span class="n">responseFormat</span><span class="o">);</span>
- <span class="n">ODataSerializer</span> <span class="n">serializer</span> <span class="o">=</span> <span class="n">odata</span><span class="o">.</span><span class="na">createSerializer</span><span class="o">(</span><span class="n">format</span><span class="o">);</span>
-
- <span class="n">ContextURL</span> <span class="n">contextUrl</span> <span class="o">=</span> <span class="n">ContextURL</span><span class="o">.</span><span class="na">with</span><span class="o">().</span><span class="na">entitySet</span><span class="o">(</span><span class="n">edmEntitySet</span><span class="o">).</span><span class="na">navOrPropertyPath</span><span class="o">(</span><span class="n">edmPropertyName</span><span class="o">).</span><span class="na">build</span><span class="o">();</span>
- <span class="n">PrimitiveSerializerOptions</span> <span class="n">options</span> <span class="o">=</span> <span class="n">PrimitiveSerializerOptions</span><span class="o">.</span><span class="na">with</span><span class="o">().</span><span class="na">contextURL</span><span class="o">(</span><span class="n">contextUrl</span><span class="o">).</span><span class="na">build</span><span class="o">();</span>
- <span class="c1">// 3.2. serialize</span>
- <span class="n">SerializerResult</span> <span class="n">serializerResult</span> <span class="o">=</span> <span class="n">serializer</span><span class="o">.</span><span class="na">primitive</span><span class="o">(</span><span class="n">edmPropertyType</span><span class="o">,</span> <span class="n">property</span><span class="o">,</span> <span class="n">options</span><span class="o">);</span>
- <span class="n">InputStream</span> <span class="n">propertyStream</span> <span class="o">=</span> <span class="n">serializerResult</span><span class="o">.</span><span class="na">getContent</span><span class="o">();</span>
-
- <span class="c1">//4. configure the response object</span>
- <span class="n">response</span><span class="o">.</span><span class="na">setContent</span><span class="o">(</span><span class="n">propertyStream</span><span class="o">);</span>
- <span class="n">response</span><span class="o">.</span><span class="na">setStatusCode</span><span class="o">(</span><span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">OK</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">());</span>
- <span class="n">response</span><span class="o">.</span><span class="na">setHeader</span><span class="o">(</span><span class="n">HttpHeader</span><span class="o">.</span><span class="na">CONTENT_TYPE</span><span class="o">,</span> <span class="n">responseFormat</span><span class="o">.</span><span class="na">toContentTypeString</span><span class="o">());</span>
- <span class="o">}</span><span class="k">else</span><span class="o">{</span>
- <span class="c1">// in case there's no value for the property, we can skip the serialization</span>
- <span class="n">response</span><span class="o">.</span><span class="na">setStatusCode</span><span class="o">(</span><span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NO_CONTENT</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">());</span>
- <span class="o">}</span>
+ <span class="n">UriResourceProperty</span> <span class="n">uriProperty</span> <span class="o">=</span> <span class="o">(</span><span class="n">UriResourceProperty</span><span class="o">)</span> <span class="n">resourceParts</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="n">resourceParts</span><span class="o">.</span><span class="na">size</span><span class="o">()</span> <span class="o">-</span><span class="mi">1</span><span class="o">);</span>
+ <span class="n">EdmProperty</span> <span class="n">edmProperty</span> <span class="o">=</span> <span class="n">uriProperty</span><span class="o">.</span><span class="na">getProperty</span><span class="o">();</span>
+ <span class="n">String</span> <span class="n">edmPropertyName</span> <span class="o">=</span> <span class="n">edmProperty</span><span class="o">.</span><span class="na">getName</span><span class="o">();</span>
+ <span class="c1">// in our example, we know we have only primitive types in our model</span>
+ <span class="n">EdmPrimitiveType</span> <span class="n">edmPropertyType</span> <span class="o">=</span> <span class="o">(</span><span class="n">EdmPrimitiveType</span><span class="o">)</span> <span class="n">edmProperty</span><span class="o">.</span><span class="na">getType</span><span class="o">();</span>
+
+ <span class="c1">// 2. retrieve data from backend</span>
+ <span class="c1">// 2.1. retrieve the entity data, for which the property has to be read</span>
+ <span class="n">Entity</span> <span class="n">entity</span> <span class="o">=</span> <span class="n">storage</span><span class="o">.</span><span class="na">readEntityData</span><span class="o">(</span><span class="n">edmEntitySet</span><span class="o">,</span> <span class="n">keyPredicates</span><span class="o">);</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">entity</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span> <span class="c1">// Bad request</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nf">ODataApplicationException</span><span class="o">(</span><span class="s">"Entity not found"</span><span class="o">,</span>
+ <span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NOT_FOUND</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">(),</span> <span class="n">Locale</span><span class="o">.</span><span class="na">ENGLISH</span><span class="o">);</span>
+ <span class="o">}</span>
+
+ <span class="c1">// 2.2. retrieve the property data from the entity</span>
+ <span class="n">Property</span> <span class="n">property</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">edmPropertyName</span><span class="o">);</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">property</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nf">ODataApplicationException</span><span class="o">(</span><span class="s">"Property not found"</span><span class="o">,</span>
+ <span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NOT_FOUND</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">(),</span> <span class="n">Locale</span><span class="o">.</span><span class="na">ENGLISH</span><span class="o">);</span>
+ <span class="o">}</span>
+
+ <span class="c1">// 3. serialize</span>
+ <span class="n">Object</span> <span class="n">value</span> <span class="o">=</span> <span class="n">property</span><span class="o">.</span><span class="na">getValue</span><span class="o">();</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">value</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
+ <span class="c1">// 3.1. configure the serializer</span>
+ <span class="n">ODataFormat</span> <span class="n">format</span> <span class="o">=</span> <span class="n">ODataFormat</span><span class="o">.</span><span class="na">fromContentType</span><span class="o">(</span><span class="n">responseFormat</span><span class="o">);</span>
+ <span class="n">ODataSerializer</span> <span class="n">serializer</span> <span class="o">=</span> <span class="n">odata</span><span class="o">.</span><span class="na">createSerializer</span><span class="o">(</span><span class="n">format</span><span class="o">);</span>
+
+ <span class="n">ContextURL</span> <span class="n">contextUrl</span> <span class="o">=</span> <span class="n">ContextURL</span><span class="o">.</span><span class="na">with</span><span class="o">().</span><span class="na">entitySet</span><span class="o">(</span><span class="n">edmEntitySet</span><span class="o">).</span><span class="na">navOrPropertyPath</span><span class="o">(</span><span class="n">edmPropertyName</span><span class="o">).</span><span class="na">build</span><span class="o">();</span>
+ <span class="n">PrimitiveSerializerOptions</span> <span class="n">options</span> <span class="o">=</span> <span class="n">PrimitiveSerializerOptions</span><span class="o">.</span><span class="na">with</span><span class="o">().</span><span class="na">contextURL</span><span class="o">(</span><span class="n">contextUrl</span><span class="o">).</span><span class="na">build</span><span class="o">();</span>
+ <span class="c1">// 3.2. serialize</span>
+ <span class="n">SerializerResult</span> <span class="n">serializerResult</span> <span class="o">=</span> <span class="n">serializer</span><span class="o">.</span><span class="na">primitive</span><span class="o">(</span><span class="n">edmPropertyType</span><span class="o">,</span> <span class="n">property</span><span class="o">,</span> <span class="n">options</span><span class="o">);</span>
+ <span class="n">InputStream</span> <span class="n">propertyStream</span> <span class="o">=</span> <span class="n">serializerResult</span><span class="o">.</span><span class="na">getContent</span><span class="o">();</span>
+
+ <span class="c1">//4. configure the response object</span>
+ <span class="n">response</span><span class="o">.</span><span class="na">setContent</span><span class="o">(</span><span class="n">propertyStream</span><span class="o">);</span>
+ <span class="n">response</span><span class="o">.</span><span class="na">setStatusCode</span><span class="o">(</span><span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">OK</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">());</span>
+ <span class="n">response</span><span class="o">.</span><span class="na">setHeader</span><span class="o">(</span><span class="n">HttpHeader</span><span class="o">.</span><span class="na">CONTENT_TYPE</span><span class="o">,</span> <span class="n">responseFormat</span><span class="o">.</span><span class="na">toContentTypeString</span><span class="o">());</span>
+ <span class="o">}</span><span class="k">else</span><span class="o">{</span>
+ <span class="c1">// in case there's no value for the property, we can skip the serialization</span>
+ <span class="n">response</span><span class="o">.</span><span class="na">setStatusCode</span><span class="o">(</span><span class="n">HttpStatusCode</span><span class="o">.</span><span class="na">NO_CONTENT</span><span class="o">.</span><span class="na">getStatusCode</span><span class="o">());</span>
+ <span class="o">}</span>
</pre></div>