<!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:38 CEST 2018 --> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<title>org.apache.olingo.server.api.uri (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="org.apache.olingo.server.api.uri (Olingo-OData 4.5.0 API)"; | |
} | |
} | |
catch(err) { | |
} | |
//--> | |
</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 class="navBarCell1Rev">Package</li> | |
<li>Class</li> | |
<li><a href="package-use.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/package-summary.html">Prev Package</a></li> | |
<li><a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/package-summary.html">Next Package</a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/uri/package-summary.html" target="_top">Frames</a></li> | |
<li><a href="package-summary.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> | |
<a name="skip.navbar.top"> | |
<!-- --> | |
</a></div> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<div class="header"> | |
<h1 title="Package" class="title">Package org.apache.olingo.server.api.uri</h1> | |
<div class="docSummary"> | |
<div class="block">Olingo URI</div> | |
</div> | |
<p>See: <a href="#package.description">Description</a></p> | |
</div> | |
<div class="contentContainer"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> | |
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> | |
<tr> | |
<th class="colFirst" scope="col">Interface</th> | |
<th class="colLast" scope="col">Description</th> | |
</tr> | |
<tbody> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriHelper.html" title="interface in org.apache.olingo.server.api.uri">UriHelper</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI-related tasks.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a></td> | |
<td class="colLast"> | |
<div class="block">Object acting as general access to URI information extracted from the request URI.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoAll.html" title="interface in org.apache.olingo.server.api.uri">UriInfoAll</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#all"><code>UriInfoKind.all</code></a> to describe URIs like | |
http://.../serviceroot/$all</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoBatch.html" title="interface in org.apache.olingo.server.api.uri">UriInfoBatch</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#batch"><code>UriInfoKind.batch</code></a> to describe URIs like | |
http://.../serviceroot/$batch</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoCrossjoin.html" title="interface in org.apache.olingo.server.api.uri">UriInfoCrossjoin</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#crossjoin"><code>UriInfoKind.crossjoin</code></a> to describe URIs like | |
http://.../serviceroot/$crossjoin(...)</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoEntityId.html" title="interface in org.apache.olingo.server.api.uri">UriInfoEntityId</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#entityId"><code>UriInfoKind.entityId</code></a> to describe URIs like | |
http://.../serviceroot/$entity...</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoMetadata.html" title="interface in org.apache.olingo.server.api.uri">UriInfoMetadata</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#metadata"><code>UriInfoKind.metadata</code></a> to describe URIs like | |
http://.../serviceroot/$metadata...</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoResource.html" title="interface in org.apache.olingo.server.api.uri">UriInfoResource</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#resource"><code>UriInfoKind.resource</code></a> to describe URIs like | |
E.g.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoService.html" title="interface in org.apache.olingo.server.api.uri">UriInfoService</a></td> | |
<td class="colLast"> | |
<div class="block">Used for URI info kind <a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html#service"><code>UriInfoKind.service</code></a> to describe URIs like | |
http://.../serviceroot</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriParameter.html" title="interface in org.apache.olingo.server.api.uri">UriParameter</a></td> | |
<td class="colLast"> | |
<div class="block">Represents a function parameter or key predicate when used in the URI.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResource.html" title="interface in org.apache.olingo.server.api.uri">UriResource</a></td> | |
<td class="colLast"> | |
<div class="block">Super interface for all objects representing resource parts.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceAction.html" title="interface in org.apache.olingo.server.api.uri">UriResourceAction</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an action used within an resource path | |
For example: http://.../serviceroot/action()</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceComplexProperty.html" title="interface in org.apache.olingo.server.api.uri">UriResourceComplexProperty</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an complex property used within an resource path | |
E.g.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceCount.html" title="interface in org.apache.olingo.server.api.uri">UriResourceCount</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an $count used within an resource path | |
For example: http://.../serviceroot/entityset(1)/$count</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceEntitySet.html" title="interface in org.apache.olingo.server.api.uri">UriResourceEntitySet</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an entity set used within an resource path | |
For example: http://.../serviceroot/entityset(1)</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceFunction.html" title="interface in org.apache.olingo.server.api.uri">UriResourceFunction</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an function import or bound function used within an resource path | |
For example: http://.../serviceroot/functionImport(P1=1,P2='A')</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceIt.html" title="interface in org.apache.olingo.server.api.uri">UriResourceIt</a></td> | |
<td class="colLast"> | |
<div class="block">Class indicating the $it reference.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceLambdaAll.html" title="interface in org.apache.olingo.server.api.uri">UriResourceLambdaAll</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an all lambda expression used within an resource path | |
For example: http://.../serviceroot/entityset/all(...)</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceLambdaAny.html" title="interface in org.apache.olingo.server.api.uri">UriResourceLambdaAny</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an any lambda expression used within an resource path | |
For example: http://.../serviceroot/entityset/any(...)</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceLambdaVariable.html" title="interface in org.apache.olingo.server.api.uri">UriResourceLambdaVariable</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an lambda variable used within an resource path | |
For example: http://.../serviceroot/entityset/listofstring/any(d: 'string' eq d)</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceNavigation.html" title="interface in org.apache.olingo.server.api.uri">UriResourceNavigation</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an navigation property used within an resource path | |
For example: http://.../serviceroot/entityset(1)/navProperty</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourcePartTyped.html" title="interface in org.apache.olingo.server.api.uri">UriResourcePartTyped</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an typed resource part (super interface)</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourcePrimitiveProperty.html" title="interface in org.apache.olingo.server.api.uri">UriResourcePrimitiveProperty</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an primitive property used within an resource path | |
For example: http://.../serviceroot/entityset(1)/property</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceProperty.html" title="interface in org.apache.olingo.server.api.uri">UriResourceProperty</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an resource part which is an property (super interface)</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceRef.html" title="interface in org.apache.olingo.server.api.uri">UriResourceRef</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an $ref used within an resource path | |
For example: http://.../serviceroot/entityset/$ref</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceRoot.html" title="interface in org.apache.olingo.server.api.uri">UriResourceRoot</a></td> | |
<td class="colLast"> | |
<div class="block">Class indicating the $root reference.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceSingleton.html" title="interface in org.apache.olingo.server.api.uri">UriResourceSingleton</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an entity set used within an resource path | |
For example: http://.../serviceroot/singleton</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceValue.html" title="interface in org.apache.olingo.server.api.uri">UriResourceValue</a></td> | |
<td class="colLast"> | |
<div class="block">Used to describe an $value used within an resource path | |
For example: http://.../serviceroot/entityset(1)/property/$value</div> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</li> | |
<li class="blockList"> | |
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> | |
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> | |
<tr> | |
<th class="colFirst" scope="col">Enum</th> | |
<th class="colLast" scope="col">Description</th> | |
</tr> | |
<tbody> | |
<tr class="altColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriInfoKind.html" title="enum in org.apache.olingo.server.api.uri">UriInfoKind</a></td> | |
<td class="colLast"> | |
<div class="block">Defining the various info kinds</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/uri/UriResourceKind.html" title="enum in org.apache.olingo.server.api.uri">UriResourceKind</a></td> | |
<td class="colLast"> | |
<div class="block">Defining the various resource part types</div> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</li> | |
</ul> | |
<a name="package.description"> | |
<!-- --> | |
</a> | |
<h2 title="Package org.apache.olingo.server.api.uri Description">Package org.apache.olingo.server.api.uri Description</h2> | |
<div class="block">Olingo URI | |
<p> | |
The URI package is used to condense all information about the OData path used to query the data. | |
<br> In order to support filter and orderby statements the | |
<a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/expression/ExpressionVisitor.html" title="interface in org.apache.olingo.server.api.uri.queryoption.expression"><code>ExpressionVisitor</code></a> has to be implemented by an | |
application.</div> | |
</div> | |
<!-- ======= 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 class="navBarCell1Rev">Package</li> | |
<li>Class</li> | |
<li><a href="package-use.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/package-summary.html">Prev Package</a></li> | |
<li><a href="../../../../../../org/apache/olingo/server/api/uri/queryoption/package-summary.html">Next Package</a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/uri/package-summary.html" target="_top">Frames</a></li> | |
<li><a href="package-summary.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> | |
<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> |