blob: c84f0b5ed0872071f98f69671a9cc6175079ff3e [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.expression (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.expression (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/uri/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/uri/expression/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.expression</h1>
<div class="docSummary">
<div class="block">Expression Parser</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/expression/BinaryExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">BinaryExpression</a></td>
<td class="colLast">
<div class="block">Represents a binary expression node in the expression tree returned by the methods
<br>
<br>
A binary expression node is inserted in the expression tree for any valid
ODATA binary operator in <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/BinaryOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression"><code>BinaryOperator</code></a> (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">CommonExpression</a></td>
<td class="colLast">
<div class="block">Parent class of all classes used to build the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionVisitor.html" title="interface in org.apache.olingo.odata2.api.uri.expression">ExpressionVisitor</a></td>
<td class="colLast">
<div class="block">Interface <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionVisitor.html" title="interface in org.apache.olingo.odata2.api.uri.expression"><code>ExpressionVisitor</code></a> is used to traverse a $filter or $orderby expression tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/FilterExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">FilterExpression</a></td>
<td class="colLast">
<div class="block">Represents a $filter expression in the expression tree
Used to define the <b>root</b> expression node in an $filter expression tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/LiteralExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">LiteralExpression</a></td>
<td class="colLast">
<div class="block">Represents a literal expression node in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/MemberExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">MemberExpression</a></td>
<td class="colLast">
<div class="block">Represents a member expression in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/MethodExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">MethodExpression</a></td>
<td class="colLast">
<div class="block">Represents a method expression in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/OrderByExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">OrderByExpression</a></td>
<td class="colLast">
<div class="block">Represents a $orderby expression
Used to define the <b>root</b> expression node in an $filter expression tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/OrderExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">OrderExpression</a></td>
<td class="colLast">
<div class="block">Represents a order expression in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/PropertyExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">PropertyExpression</a></td>
<td class="colLast">
<div class="block">Represents a property expression in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/UnaryExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">UnaryExpression</a></td>
<td class="colLast">
<div class="block">Represents a unary expression node in the expression tree
<br>
<br></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html" title="interface in org.apache.olingo.odata2.api.uri.expression">Visitable</a></td>
<td class="colLast">
<div class="block">The interface <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html" title="interface in org.apache.olingo.odata2.api.uri.expression"><code>Visitable</code></a> is part of the visitor pattern used to traverse
the expression tree build from a $filter expression string or $orderby expression string.</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">&nbsp;</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/odata2/api/uri/expression/BinaryOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression">BinaryOperator</a></td>
<td class="colLast">
<div class="block">Enumerations for supported binary operators of the ODATA expression parser
for ODATA version 2.0 (with some restrictions)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionKind.html" title="enum in org.apache.olingo.odata2.api.uri.expression">ExpressionKind</a></td>
<td class="colLast">
<div class="block">Enumeration describing all possible node types inside an expression tree</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/MethodOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression">MethodOperator</a></td>
<td class="colLast">
<div class="block">Enumerations for all supported methods of the ODATA expression parser
for ODATA version 2.0 (with some restrictions).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/SortOrder.html" title="enum in org.apache.olingo.odata2.api.uri.expression">SortOrder</a></td>
<td class="colLast">
<div class="block">Enumeration describing all possible sort orders used in an $orderby expression</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/UnaryOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression">UnaryOperator</a></td>
<td class="colLast">
<div class="block">Enumerations for supported unary operators of the OData expression parser
for OData version 2.0</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/expression/ExceptionVisitExpression.html" title="class in org.apache.olingo.odata2.api.uri.expression">ExceptionVisitExpression</a></td>
<td class="colLast">
<div class="block">Exception thrown while traversing/visiting a filter expression tree</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionParserException.html" title="class in org.apache.olingo.odata2.api.uri.expression">ExpressionParserException</a></td>
<td class="colLast">
<div class="block">Exception thrown while parsing a filter or orderby expression</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.api.uri.expression Description">Package org.apache.olingo.odata2.api.uri.expression Description</h2>
<div class="block">Expression Parser
<p>This package contains all classes necessary to decribe an expression tree(e.g. a filter or order by tree)
<p>Trees can be traversed by implementing the <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionVisitor.html" title="interface in org.apache.olingo.odata2.api.uri.expression"><code>ExpressionVisitor</code></a>
interface and calling the accept() method.
<br>Different types of expressions can be found in <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionKind.html" title="enum in org.apache.olingo.odata2.api.uri.expression"><code>ExpressionKind</code></a>
.</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/uri/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/uri/expression/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>