Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / serializer / EdmAssistedSerializer.html
blob: bdc16beb930fcba4e0ae3ff66ccd6bb8247e0001 [file] [log] [blame]
<!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:35 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EdmAssistedSerializer (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="EdmAssistedSerializer (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/EdmAssistedSerializer.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/serializer/CustomContentTypeSupport.html" title="interface in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/EdmAssistedSerializer.html" target="_top">Frames</a></li>
<li><a href="EdmAssistedSerializer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.serializer</div>
<h2 title="Interface EdmAssistedSerializer" class="title">Interface EdmAssistedSerializer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EdmAssistedSerializer</span></pre>
<div class="block">EDM-assisted serializer</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/serializer/SerializerResult.html" title="interface in org.apache.olingo.server.api.serializer">SerializerResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializer.html#entityCollection-org.apache.olingo.server.api.ServiceMetadata-org.apache.olingo.commons.api.edm.EdmEntityType-org.apache.olingo.commons.api.data.AbstractEntityCollection-org.apache.olingo.server.api.serializer.EdmAssistedSerializerOptions-">entityCollection</a></span>(<a href="../../../../../../org/apache/olingo/server/api/ServiceMetadata.html" title="interface in org.apache.olingo.server.api">ServiceMetadata</a>&nbsp;metadata,
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a>&nbsp;referencedEntityType,
<a href="../../../../../../org/apache/olingo/commons/api/data/AbstractEntityCollection.html" title="class in org.apache.olingo.commons.api.data">AbstractEntityCollection</a>&nbsp;entityCollection,
<a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">EdmAssistedSerializerOptions</a>&nbsp;options)</code>
<div class="block">Writes entity-collection data into an InputStream.</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="entityCollection-org.apache.olingo.server.api.ServiceMetadata-org.apache.olingo.commons.api.edm.EdmEntityType-org.apache.olingo.commons.api.data.AbstractEntityCollection-org.apache.olingo.server.api.serializer.EdmAssistedSerializerOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>entityCollection</h4>
<pre><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerResult.html" title="interface in org.apache.olingo.server.api.serializer">SerializerResult</a>&nbsp;entityCollection(<a href="../../../../../../org/apache/olingo/server/api/ServiceMetadata.html" title="interface in org.apache.olingo.server.api">ServiceMetadata</a>&nbsp;metadata,
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a>&nbsp;referencedEntityType,
<a href="../../../../../../org/apache/olingo/commons/api/data/AbstractEntityCollection.html" title="class in org.apache.olingo.commons.api.data">AbstractEntityCollection</a>&nbsp;entityCollection,
<a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">EdmAssistedSerializerOptions</a>&nbsp;options)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></pre>
<div class="block">Writes entity-collection data into an InputStream.
Information from the EDM is used in addition to information from the data and preferred,
but the serializer works without any EDM information as well.
Linked data is always written as expanded items (so closed reference loops have to be avoided).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metadata</code> - metadata for the service</dd>
<dd><code>referencedEntityType</code> - the <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmEntityType</code></a> or <code>null</code> if not available</dd>
<dd><code>entityCollection</code> - the data of the entity collection</dd>
<dd><code>options</code> - options for the serializer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</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/EdmAssistedSerializer.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/serializer/CustomContentTypeSupport.html" title="interface in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/EdmAssistedSerializer.html" target="_top">Frames</a></li>
<li><a href="EdmAssistedSerializer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>