<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!-- NewPage --> | |
<html lang="en"> | |
<head> | |
<!-- Generated by javadoc (1.8.0_92) on Mon Aug 13 15:36:34 CEST 2018 --> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<title>ODataDeserializer (Olingo-OData 4.5.0 API)</title> | |
<meta name="date" content="2018-08-13"> | |
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> | |
<script type="text/javascript" src="../../../../../../script.js"></script> | |
</head> | |
<body> | |
<script type="text/javascript"><!-- | |
try { | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="ODataDeserializer (Olingo-OData 4.5.0 API)"; | |
} | |
} | |
catch(err) { | |
} | |
//--> | |
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; | |
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; | |
var altColor = "altColor"; | |
var rowColor = "rowColor"; | |
var tableTab = "tableTab"; | |
var activeTableTab = "activeTableTab"; | |
</script> | |
<noscript> | |
<div>JavaScript is disabled on your browser.</div> | |
</noscript> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<div class="topNav"><a name="navbar.top"> | |
<!-- --> | |
</a> | |
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | |
<a name="navbar.top.firstrow"> | |
<!-- --> | |
</a> | |
<ul class="navList" title="Navigation"> | |
<li><a href="../../../../../../overview-summary.html">Overview</a></li> | |
<li><a href="package-summary.html">Package</a></li> | |
<li class="navBarCell1Rev">Class</li> | |
<li><a href="class-use/ODataDeserializer.html">Use</a></li> | |
<li><a href="package-tree.html">Tree</a></li> | |
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> | |
<li><a href="../../../../../../index-all.html">Index</a></li> | |
<li><a href="../../../../../../help-doc.html">Help</a></li> | |
</ul> | |
</div> | |
<div class="subNav"> | |
<ul class="navList"> | |
<li><a href="../../../../../../org/apache/olingo/server/api/deserializer/FixedFormatDeserializer.html" title="interface in org.apache.olingo.server.api.deserializer"><span class="typeNameLink">Prev Class</span></a></li> | |
<li>Next Class</li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/deserializer/ODataDeserializer.html" target="_top">Frames</a></li> | |
<li><a href="ODataDeserializer.html" target="_top">No Frames</a></li> | |
</ul> | |
<ul class="navList" id="allclasses_navbar_top"> | |
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> | |
</ul> | |
<div> | |
<script type="text/javascript"><!-- | |
allClassesLink = document.getElementById("allclasses_navbar_top"); | |
if(window==top) { | |
allClassesLink.style.display = "block"; | |
} | |
else { | |
allClassesLink.style.display = "none"; | |
} | |
//--> | |
</script> | |
</div> | |
<div> | |
<ul class="subNavList"> | |
<li>Summary: </li> | |
<li>Nested | </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.detail">Method</a></li> | |
</ul> | |
</div> | |
<a name="skip.navbar.top"> | |
<!-- --> | |
</a></div> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<div class="header"> | |
<div class="subTitle">org.apache.olingo.server.api.deserializer</div> | |
<h2 title="Interface ODataDeserializer" class="title">Interface ODataDeserializer</h2> | |
</div> | |
<div class="contentContainer"> | |
<div class="description"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<hr> | |
<br> | |
<pre>public interface <span class="typeNameLabel">ODataDeserializer</span></pre> | |
<div class="block">Deserializer on OData server side.</div> | |
</li> | |
</ul> | |
</div> | |
<div class="summary"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<!-- ========== METHOD SUMMARY =========== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="method.summary"> | |
<!-- --> | |
</a> | |
<h3>Method Summary</h3> | |
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> | |
<tr> | |
<th class="colFirst" scope="col">Modifier and Type</th> | |
<th class="colLast" scope="col">Method and Description</th> | |
</tr> | |
<tr id="i0" class="altColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/deserializer/ODataDeserializer.html#actionParameters-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmAction-">actionParameters</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAction.html" title="interface in org.apache.olingo.commons.api.edm">EdmAction</a> edmAction)</code> | |
<div class="block">Deserializes an action-parameters stream into a map of key/value pairs.</div> | |
</td> | |
</tr> | |
<tr id="i1" class="rowColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/deserializer/ODataDeserializer.html#entity-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmEntityType-">entity</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a> edmEntityType)</code> | |
<div class="block">Deserializes an entity stream into an <a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data"><code>Entity</code></a> object.</div> | |
</td> | |
</tr> | |
<tr id="i2" class="altColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/deserializer/ODataDeserializer.html#entityCollection-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmEntityType-">entityCollection</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a> edmEntityType)</code> | |
<div class="block">Deserializes an entity collection stream into an <a href="../../../../../../org/apache/olingo/commons/api/data/EntityCollection.html" title="class in org.apache.olingo.commons.api.data"><code>EntityCollection</code></a> object.</div> | |
</td> | |
</tr> | |
<tr id="i3" class="rowColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/deserializer/ODataDeserializer.html#entityReferences-java.io.InputStream-">entityReferences</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream)</code> | |
<div class="block">Reads entity references from the provided document.</div> | |
</td> | |
</tr> | |
<tr id="i4" class="altColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/deserializer/ODataDeserializer.html#property-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmProperty-">property</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmProperty.html" title="interface in org.apache.olingo.commons.api.edm">EdmProperty</a> edmProperty)</code> | |
<div class="block">Deserializes the Property or collections of properties (primitive & complex).</div> | |
</td> | |
</tr> | |
</table> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
</div> | |
<div class="details"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<!-- ============ METHOD DETAIL ========== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="method.detail"> | |
<!-- --> | |
</a> | |
<h3>Method Detail</h3> | |
<a name="entity-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmEntityType-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>entity</h4> | |
<pre><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a> entity(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a> edmEntityType) | |
throws <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></pre> | |
<div class="block">Deserializes an entity stream into an <a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data"><code>Entity</code></a> object. | |
Validates: property types, no double properties, correct json types. | |
Returns a deserialized <a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data"><code>Entity</code></a> object and an | |
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption"><code>ExpandOption</code></a> object.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>stream</code> - </dd> | |
<dd><code>edmEntityType</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getEntity--"><code>DeserializerResult.getEntity()</code></a> and <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getExpandTree--"><code>DeserializerResult.getExpandTree()</code></a></dd> | |
<dt><span class="throwsLabel">Throws:</span></dt> | |
<dd><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="entityCollection-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmEntityType-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>entityCollection</h4> | |
<pre><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a> entityCollection(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a> edmEntityType) | |
throws <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></pre> | |
<div class="block">Deserializes an entity collection stream into an <a href="../../../../../../org/apache/olingo/commons/api/data/EntityCollection.html" title="class in org.apache.olingo.commons.api.data"><code>EntityCollection</code></a> object.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>stream</code> - </dd> | |
<dd><code>edmEntityType</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getEntityCollection--"><code>DeserializerResult.getEntityCollection()</code></a></dd> | |
<dt><span class="throwsLabel">Throws:</span></dt> | |
<dd><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="actionParameters-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmAction-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>actionParameters</h4> | |
<pre><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a> actionParameters(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAction.html" title="interface in org.apache.olingo.commons.api.edm">EdmAction</a> edmAction) | |
throws <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></pre> | |
<div class="block">Deserializes an action-parameters stream into a map of key/value pairs. | |
Validates: parameter types, no double parameters, correct json types.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>stream</code> - </dd> | |
<dd><code>edmAction</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getActionParameters--"><code>DeserializerResult.getActionParameters()</code></a></dd> | |
<dt><span class="throwsLabel">Throws:</span></dt> | |
<dd><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="property-java.io.InputStream-org.apache.olingo.commons.api.edm.EdmProperty-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>property</h4> | |
<pre><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a> property(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, | |
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmProperty.html" title="interface in org.apache.olingo.commons.api.edm">EdmProperty</a> edmProperty) | |
throws <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></pre> | |
<div class="block">Deserializes the Property or collections of properties (primitive & complex).</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>stream</code> - </dd> | |
<dd><code>edmProperty</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getProperty--"><code>DeserializerResult.getProperty()</code></a></dd> | |
<dt><span class="throwsLabel">Throws:</span></dt> | |
<dd><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="entityReferences-java.io.InputStream-"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>entityReferences</h4> | |
<pre><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html" title="interface in org.apache.olingo.server.api.deserializer">DeserializerResult</a> entityReferences(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream) | |
throws <a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></pre> | |
<div class="block">Reads entity references from the provided document.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>stream</code> - </dd> | |
<dd><code>keys</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerResult.html#getEntityReferences--"><code>DeserializerResult.getEntityReferences()</code></a></dd> | |
<dt><span class="throwsLabel">Throws:</span></dt> | |
<dd><code><a href="../../../../../../org/apache/olingo/server/api/deserializer/DeserializerException.html" title="class in org.apache.olingo.server.api.deserializer">DeserializerException</a></code></dd> | |
</dl> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
</div> | |
</div> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<div class="bottomNav"><a name="navbar.bottom"> | |
<!-- --> | |
</a> | |
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | |
<a name="navbar.bottom.firstrow"> | |
<!-- --> | |
</a> | |
<ul class="navList" title="Navigation"> | |
<li><a href="../../../../../../overview-summary.html">Overview</a></li> | |
<li><a href="package-summary.html">Package</a></li> | |
<li class="navBarCell1Rev">Class</li> | |
<li><a href="class-use/ODataDeserializer.html">Use</a></li> | |
<li><a href="package-tree.html">Tree</a></li> | |
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> | |
<li><a href="../../../../../../index-all.html">Index</a></li> | |
<li><a href="../../../../../../help-doc.html">Help</a></li> | |
</ul> | |
</div> | |
<div class="subNav"> | |
<ul class="navList"> | |
<li><a href="../../../../../../org/apache/olingo/server/api/deserializer/FixedFormatDeserializer.html" title="interface in org.apache.olingo.server.api.deserializer"><span class="typeNameLink">Prev Class</span></a></li> | |
<li>Next Class</li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/deserializer/ODataDeserializer.html" target="_top">Frames</a></li> | |
<li><a href="ODataDeserializer.html" target="_top">No Frames</a></li> | |
</ul> | |
<ul class="navList" id="allclasses_navbar_bottom"> | |
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> | |
</ul> | |
<div> | |
<script type="text/javascript"><!-- | |
allClassesLink = document.getElementById("allclasses_navbar_bottom"); | |
if(window==top) { | |
allClassesLink.style.display = "block"; | |
} | |
else { | |
allClassesLink.style.display = "none"; | |
} | |
//--> | |
</script> | |
</div> | |
<div> | |
<ul class="subNavList"> | |
<li>Summary: </li> | |
<li>Nested | </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.detail">Method</a></li> | |
</ul> | |
</div> | |
<a name="skip.navbar.bottom"> | |
<!-- --> | |
</a></div> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<p class="legalCopy"><small>Copyright © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
</body> | |
</html> |