Author: buildbot
Date: Tue Apr 28 12:55:47 2015
New Revision: 949490
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/odata4/tutorials/read/tutorial_read.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Apr 28 12:55:47 2015
@@ -1 +1 @@
-1676522
+1676523
Modified:
websites/staging/olingo/trunk/content/doc/odata4/tutorials/read/tutorial_read.html
==============================================================================
---
websites/staging/olingo/trunk/content/doc/odata4/tutorials/read/tutorial_read.html
(original)
+++
websites/staging/olingo/trunk/content/doc/odata4/tutorials/read/tutorial_read.html
Tue Apr 28 12:55:47 2015
@@ -659,39 +659,41 @@ Because the <em>readEntityCollection</em
The response object has been passed to us in the method signature. We use it
to set the serialized data (the <em>InputStream</em> object).<br />
Furthermore, we have to set the HTTP status code, which means that we have
the opportunity to do proper error handling.<br />
And finally we have to set the content type. </p>
-<p>:::java
- public void readEntityCollection(ODataRequest request, ODataResponse
response, UriInfo uriInfo, ContentType responseFormat)
- throws ODataApplicationException, SerializerException {
- // 1st retrieve the requested EntitySet from the uriInfo (representation
of the parsed URI)
- List<UriResource> resourcePaths = uriInfo.getUriResourceParts();
- // in our example, the first segment is the EntitySet:
- UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet)
resourcePaths.get(0);
- EdmEntitySet edmEntitySet = uriResourceEntitySet.getEntitySet();</p>
-<div class="codehilite"><pre><span class="c1">// 2nd: fetch the data from
backend for this requested EntitySetName and delivere as EntitySet</span>
-<span class="n">EntitySet</span> <span class="n">entitySet</span> <span
class="o">=</span> <span class="n">getData</span><span class="p">(</span><span
class="n">edmEntitySet</span><span class="p">);</span>
-
-<span class="c1">// 3rd: create a serializer based on the requested format
(json)</span>
-<span class="n">ODataFormat</span> <span class="n">format</span> <span
class="o">=</span> <span class="n">ODataFormat</span><span
class="p">.</span><span class="n">fromContentType</span><span
class="p">(</span><span class="n">responseFormat</span><span class="p">);</span>
-<span class="n">ODataSerializer</span> <span class="n">serializer</span> <span
class="o">=</span> <span class="n">odata</span><span class="p">.</span><span
class="n">createSerializer</span><span class="p">(</span><span
class="n">format</span><span class="p">);</span>
-
-<span class="c1">// and serialize the content: transform from the EntitySet
object to InputStream</span>
-<span class="n">EdmEntityType</span> <span class="n">edmEntityType</span>
<span class="o">=</span> <span class="n">edmEntitySet</span><span
class="p">.</span><span class="n">getEntityType</span><span class="p">();</span>
-<span class="n">ContextURL</span> <span class="n">contextUrl</span> <span
class="o">=</span> <span class="n">ContextURL</span><span
class="p">.</span><span class="k">with</span><span class="p">().</span><span
class="n">entitySet</span><span class="p">(</span><span
class="n">edmEntitySet</span><span class="p">).</span><span
class="n">build</span><span class="p">();</span>
-
-<span class="n">EntityCollectionSerializerOptions</span> <span
class="n">opts</span> <span class="o">=</span>
- <span class="n">EntityCollectionSerializerOptions</span><span
class="p">.</span><span class="k">with</span><span class="p">().</span><span
class="n">contextURL</span><span class="p">(</span><span
class="n">contextUrl</span><span class="p">).</span><span
class="n">build</span><span class="p">();</span>
-<span class="n">InputStream</span> <span class="n">serializedContent</span>
<span class="o">=</span> <span class="n">serializer</span><span
class="p">.</span><span class="n">entityCollection</span><span
class="p">(</span><span class="n">edmEntityType</span><span class="p">,</span>
<span class="n">entitySet</span><span class="p">,</span> <span
class="n">opts</span><span class="p">);</span>
-
-<span class="c1">// 4th: configure the response object: set the body, headers
and status code</span>
-<span class="n">response</span><span class="p">.</span><span
class="n">setContent</span><span class="p">(</span><span
class="n">serializedContent</span><span class="p">);</span>
-<span class="n">response</span><span class="p">.</span><span
class="n">setStatusCode</span><span class="p">(</span><span
class="n">HttpStatusCode</span><span class="p">.</span><span
class="no">OK</span><span class="p">.</span><span
class="n">getStatusCode</span><span class="p">());</span>
-<span class="n">response</span><span class="p">.</span><span
class="n">setHeader</span><span class="p">(</span><span
class="n">HttpHeader</span><span class="p">.</span><span
class="no">CONTENT_TYPE</span><span class="p">,</span> <span
class="n">responseFormat</span><span class="p">.</span><span
class="n">toContentTypeString</span><span class="p">());</span>
+</li>
+</ol>
+<p>Sample:</p>
+<div class="codehilite"><pre><span class="kd">public</span> <span
class="kt">void</span> <span class="nf">readEntityCollection</span><span
class="o">(</span><span class="n">ODataRequest</span> <span
class="n">request</span><span class="o">,</span> <span
class="n">ODataResponse</span> <span class="n">response</span><span
class="o">,</span> <span class="n">UriInfo</span> <span
class="n">uriInfo</span><span class="o">,</span> <span
class="n">ContentType</span> <span class="n">responseFormat</span><span
class="o">)</span>
+ <span class="kd">throws</span> <span
class="n">ODataApplicationException</span><span class="o">,</span> <span
class="n">SerializerException</span> <span class="o">{</span>
+
+ <span class="c1">// 1st retrieve the requested EntitySet from the uriInfo
(representation of the parsed URI)</span>
+ <span class="n">List</span><span class="o"><</span><span
class="n">UriResource</span><span class="o">></span> <span
class="n">resourcePaths</span> <span class="o">=</span> <span
class="n">uriInfo</span><span class="o">.</span><span
class="na">getUriResourceParts</span><span class="o">();</span>
+ <span class="c1">// in our example, the first segment is the
EntitySet:</span>
+ <span class="n">UriResourceEntitySet</span> <span
class="n">uriResourceEntitySet</span> <span class="o">=</span> <span
class="o">(</span><span class="n">UriResourceEntitySet</span><span
class="o">)</span> <span class="n">resourcePaths</span><span
class="o">.</span><span class="na">get</span><span class="o">(</span><span
class="mi">0</span><span class="o">);</span>
+ <span class="n">EdmEntitySet</span> <span class="n">edmEntitySet</span>
<span class="o">=</span> <span class="n">uriResourceEntitySet</span><span
class="o">.</span><span class="na">getEntitySet</span><span class="o">();</span>
+
+ <span class="c1">// 2nd: fetch the data from backend for this requested
EntitySetName and delivere as EntitySet</span>
+ <span class="n">EntitySet</span> <span class="n">entitySet</span> <span
class="o">=</span> <span class="n">getData</span><span class="o">(</span><span
class="n">edmEntitySet</span><span class="o">);</span>
+
+ <span class="c1">// 3rd: create a serializer based on the requested format
(json)</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="c1">// and serialize the content: transform from the
EntitySet object to InputStream</span>
+ <span class="n">EdmEntityType</span> <span class="n">edmEntityType</span>
<span class="o">=</span> <span class="n">edmEntitySet</span><span
class="o">.</span><span class="na">getEntityType</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">build</span><span class="o">();</span>
+
+ <span class="n">EntityCollectionSerializerOptions</span> <span
class="n">opts</span> <span class="o">=</span>
+ <span
class="n">EntityCollectionSerializerOptions</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="n">InputStream</span> <span
class="n">serializedContent</span> <span class="o">=</span> <span
class="n">serializer</span><span class="o">.</span><span
class="na">entityCollection</span><span class="o">(</span><span
class="n">edmEntityType</span><span class="o">,</span> <span
class="n">entitySet</span><span class="o">,</span> <span
class="n">opts</span><span class="o">);</span>
+
+ <span class="c1">// 4th: configure the response object: set the body,
headers and status code</span>
+ <span class="n">response</span><span class="o">.</span><span
class="na">setContent</span><span class="o">(</span><span
class="n">serializedContent</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>
</pre></div>
-<p>}</p>
-</li>
-</ol>
<p><strong><em>getData()</em></strong></p>
<p>Up to now, we havenât elaborated on fetching the actual data.
In our tutorial, to keep the code as simple as possible, we use a little
helper method that delivers some hardcoded entries.<br />
