blob: d18e6b045ac95edc16199133087bfc81bb433c3f [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 Wed Dec 06 14:36:24 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.odata2.api.uri (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<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.odata2.api.uri (olingo-odata2-parent 2.0.10 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/odata2/api/servicedocument/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/uri/expression/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/uri/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.olingo.odata2.api.uri</h1>
<div class="docSummary">
<div class="block">URI Parser Facade</div>
</div>
<p>See:&nbsp;<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">&nbsp;</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/odata2/api/uri/KeyPredicate.html" title="interface in org.apache.olingo.odata2.api.uri">KeyPredicate</a></td>
<td class="colLast">
<div class="block">Key predicate, consisting of a simple-type property and its value as String literal</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/NavigationPropertySegment.html" title="interface in org.apache.olingo.odata2.api.uri">NavigationPropertySegment</a></td>
<td class="colLast">
<div class="block">Navigation property segment, consisting of a navigation property and its
target entity set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/NavigationSegment.html" title="interface in org.apache.olingo.odata2.api.uri">NavigationSegment</a></td>
<td class="colLast">
<div class="block">Navigation segment, consisting of a navigation property, its target entity set,
and, optionally, a list of key predicates to determine a single entity out of
the target entity set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/PathInfo.html" title="interface in org.apache.olingo.odata2.api.uri">PathInfo</a></td>
<td class="colLast">
<div class="block">Object to keep OData URI information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/PathSegment.html" title="interface in org.apache.olingo.odata2.api.uri">PathSegment</a></td>
<td class="colLast">
<div class="block">URI path segment consisting of an URI path element and URI matrix parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/SelectItem.html" title="interface in org.apache.olingo.odata2.api.uri">SelectItem</a></td>
<td class="colLast">
<div class="block">An item of a $select system query option.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/UriInfo.html" title="interface in org.apache.olingo.odata2.api.uri">UriInfo</a></td>
<td class="colLast">
<div class="block">Structured parts of the request URI - the result of URI parsing.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/ExpandSelectTreeNode.html" title="class in org.apache.olingo.odata2.api.uri">ExpandSelectTreeNode</a></td>
<td class="colLast">
<div class="block">Expression tree node with information about selected properties and to be expanded links.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder.html" title="class in org.apache.olingo.odata2.api.uri">ExpandSelectTreeNode.ExpandSelectTreeNodeBuilder</a></td>
<td class="colLast">
<div class="block">Builder interface</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/UriParser.html" title="class in org.apache.olingo.odata2.api.uri">UriParser</a></td>
<td class="colLast">
<div class="block">Wrapper for UriParser functionality.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/UriNotMatchingException.html" title="class in org.apache.olingo.odata2.api.uri">UriNotMatchingException</a></td>
<td class="colLast">
<div class="block">URI-parsing exception resulting in a 404 Not Found response.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/uri/UriSyntaxException.html" title="class in org.apache.olingo.odata2.api.uri">UriSyntaxException</a></td>
<td class="colLast">
<div class="block">Exception for violation of the OData URI construction rules,
resulting in a 400 Bad Request response.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.api.uri Description">Package org.apache.olingo.odata2.api.uri Description</h2>
<div class="block"><p>URI Parser Facade</p>
<p>The URI package has one central class <a href="../../../../../../org/apache/olingo/odata2/api/uri/UriParser.html" title="class in org.apache.olingo.odata2.api.uri"><code>UriParser</code></a> to parse a request URI
as well as several interfaces that provide access to parsed parts of the URI.
<br>The <a href="../../../../../../org/apache/olingo/odata2/api/uri/UriParser.html" title="class in org.apache.olingo.odata2.api.uri"><code>UriParser</code></a> class also provides the possibility to parse a filter or
an orderBy Statement. Both are specified in the OData Protocol Specification.
<br>The URI syntax is specified in the OData Protocol Specification in the form of an ABNF. </p></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/odata2/api/servicedocument/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/uri/expression/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/uri/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>