Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / uri / UriHelper.html
blob: eefd528a51e1f02040492160ace9276f1c60374d [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>UriHelper (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="UriHelper (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/UriHelper.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/uri/UriHelper.html" target="_top">Frames</a></li>
<li><a href="UriHelper.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.uri</div>
<h2 title="Interface UriHelper" class="title">Interface UriHelper</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UriHelper</span></pre>
<div class="block">Used for URI-related tasks.</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="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html#buildCanonicalURL-org.apache.olingo.commons.api.edm.EdmEntitySet-org.apache.olingo.commons.api.data.Entity-">buildCanonicalURL</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a>&nbsp;edmEntitySet,
<a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data">Entity</a>&nbsp;entity)</code>
<div class="block">Builds the relative canonical URL for the given entity in the given entity set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html#buildContextURLKeyPredicate-java.util.List-">buildContextURLKeyPredicate</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/server/api/uri/UriParameter.html" title="interface in org.apache.olingo.server.api.uri">UriParameter</a>&gt;&nbsp;keys)</code>
<div class="block">Builds the key-predicate part of a <a href="../../../../../../org/apache/olingo/commons/api/data/ContextURL.html" title="class in org.apache.olingo.commons.api.data"><code>ContextURL</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html#buildContextURLSelectList-org.apache.olingo.commons.api.edm.EdmStructuredType-org.apache.olingo.server.api.uri.queryoption.ExpandOption-org.apache.olingo.server.api.uri.queryoption.SelectOption-">buildContextURLSelectList</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm">EdmStructuredType</a>&nbsp;type,
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandOption</a>&nbsp;expand,
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectOption</a>&nbsp;select)</code>
<div class="block">Builds the select-list part of a <a href="../../../../../../org/apache/olingo/commons/api/data/ContextURL.html" title="class in org.apache.olingo.commons.api.data"><code>ContextURL</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html#buildKeyPredicate-org.apache.olingo.commons.api.edm.EdmEntityType-org.apache.olingo.commons.api.data.Entity-">buildKeyPredicate</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a>&nbsp;edmEntityType,
<a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data">Entity</a>&nbsp;entity)</code>
<div class="block">Builds the key predicate for the given entity.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceEntitySet.html" title="interface in org.apache.olingo.server.api.uri">UriResourceEntitySet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html#parseEntityId-org.apache.olingo.commons.api.edm.Edm-java.lang.String-java.lang.String-">parseEntityId</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/Edm.html" title="interface in org.apache.olingo.commons.api.edm">Edm</a>&nbsp;edm,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entityId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rawServiceRoot)</code>
<div class="block">Parses a given entity-id.</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="buildContextURLSelectList-org.apache.olingo.commons.api.edm.EdmStructuredType-org.apache.olingo.server.api.uri.queryoption.ExpandOption-org.apache.olingo.server.api.uri.queryoption.SelectOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildContextURLSelectList</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;buildContextURLSelectList(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm">EdmStructuredType</a>&nbsp;type,
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandOption</a>&nbsp;expand,
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectOption</a>&nbsp;select)
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">Builds the select-list part of a <a href="../../../../../../org/apache/olingo/commons/api/data/ContextURL.html" title="class in org.apache.olingo.commons.api.data"><code>ContextURL</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmStructuredType</code></a></dd>
<dd><code>expand</code> - the $expand option</dd>
<dd><code>select</code> - the $select option</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String with the select list</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>
<a name="buildContextURLKeyPredicate-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildContextURLKeyPredicate</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;buildContextURLKeyPredicate(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/server/api/uri/UriParameter.html" title="interface in org.apache.olingo.server.api.uri">UriParameter</a>&gt;&nbsp;keys)
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">Builds the key-predicate part of a <a href="../../../../../../org/apache/olingo/commons/api/data/ContextURL.html" title="class in org.apache.olingo.commons.api.data"><code>ContextURL</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keys</code> - the keys as a list of <a href="../../../../../../org/apache/olingo/server/api/uri/UriParameter.html" title="interface in org.apache.olingo.server.api.uri"><code>UriParameter</code></a> instances</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String with the key predicate</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>
<a name="buildCanonicalURL-org.apache.olingo.commons.api.edm.EdmEntitySet-org.apache.olingo.commons.api.data.Entity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCanonicalURL</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;buildCanonicalURL(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a>&nbsp;edmEntitySet,
<a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data">Entity</a>&nbsp;entity)
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">Builds the relative canonical URL for the given entity in the given entity set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edmEntitySet</code> - the entity set</dd>
<dd><code>entity</code> - the entity data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the relative canonical URL</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>
<a name="buildKeyPredicate-org.apache.olingo.commons.api.edm.EdmEntityType-org.apache.olingo.commons.api.data.Entity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildKeyPredicate</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;buildKeyPredicate(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a>&nbsp;edmEntityType,
<a href="../../../../../../org/apache/olingo/commons/api/data/Entity.html" title="class in org.apache.olingo.commons.api.data">Entity</a>&nbsp;entity)
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">Builds the key predicate for the given entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edmEntityType</code> - the entity type of the entity</dd>
<dd><code>entity</code> - the entity data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key predicate</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>
<a name="parseEntityId-org.apache.olingo.commons.api.edm.Edm-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parseEntityId</h4>
<pre><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceEntitySet.html" title="interface in org.apache.olingo.server.api.uri">UriResourceEntitySet</a>&nbsp;parseEntityId(<a href="../../../../../../org/apache/olingo/commons/api/edm/Edm.html" title="interface in org.apache.olingo.commons.api.edm">Edm</a>&nbsp;edm,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entityId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rawServiceRoot)
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">Parses a given entity-id. Provides the entity set and key predicates.
A canonical entiy-id to an entity must follow the pattern
<code>[&lt;service root&gt;][&lt;entityContainer&gt;.]&lt;entitySet&gt;(&lt;key&gt;)</code>, i.e.,
it must be a relative or absolute URI consisting of an entity set (qualified
with an entity-container name if not in the default entity container) and a
syntactically valid key that identifies a single entity; example:
<code>http://example.server.com/service.svc/Employees('42')</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edm</code> - the edm the entity belongs to</dd>
<dd><code>entityId</code> - URI of the entity-id</dd>
<dd><code>rawServiceRoot</code> - the root URI of the service</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceEntitySet.html" title="interface in org.apache.olingo.server.api.uri"><code>UriResourceEntitySet</code></a> - contains the entity set and the key predicates</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> - in case the entity-id is malformed</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/UriHelper.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/uri/UriHelper.html" target="_top">Frames</a></li>
<li><a href="UriHelper.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>