blob: 65827ecca0e16991b41ca4856d7b9f8d65aa3903 [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:22 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CommonExpression (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="CommonExpression (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/CommonExpression.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/expression/BinaryOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExceptionVisitExpression.html" title="class in org.apache.olingo.odata2.api.uri.expression"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/uri/expression/CommonExpression.html" target="_top">Frames</a></li>
<li><a href="CommonExpression.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.odata2.api.uri.expression</div>
<h2 title="Interface CommonExpression" class="title">Interface CommonExpression</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html" title="interface in org.apache.olingo.odata2.api.uri.expression">Visitable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/BinaryExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">BinaryExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/FilterExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">FilterExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/LiteralExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">LiteralExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/MemberExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">MemberExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/MethodExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">MethodExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/OrderByExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">OrderByExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/OrderExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">OrderExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/PropertyExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">PropertyExpression</a>, <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/UnaryExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">UnaryExpression</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CommonExpression</span>
extends <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html" title="interface in org.apache.olingo.odata2.api.uri.expression">Visitable</a></pre>
<div class="block">Parent class of all classes used to build the expression tree
<br>
<br>
<p>This interface defines the default methods for all expression tree nodes
<br>
<br></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/odata2/api/edm/EdmType.html" title="interface in org.apache.olingo.odata2.api.edm">EdmType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html#getEdmType--">getEdmType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionKind.html" title="enum in org.apache.olingo.odata2.api.uri.expression">ExpressionKind</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html#getKind--">getKind</a></span>()</code>&nbsp;</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/odata2/api/uri/expression/CommonExpression.html#getUriLiteral--">getUriLiteral</a></span>()</code>
<div class="block">Returns the URI literal which lead to the creation of this expression.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">CommonExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html#setEdmType-org.apache.olingo.odata2.api.edm.EdmType-">setEdmType</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/edm/EdmType.html" title="interface in org.apache.olingo.odata2.api.edm">EdmType</a>&nbsp;edmType)</code>
<div class="block">Set the edmType of this expression node</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.odata2.api.uri.expression.Visitable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.odata2.api.uri.expression.<a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html" title="interface in org.apache.olingo.odata2.api.uri.expression">Visitable</a></h3>
<code><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/Visitable.html#accept-org.apache.olingo.odata2.api.uri.expression.ExpressionVisitor-">accept</a></code></li>
</ul>
</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="getKind--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKind</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionKind.html" title="enum in org.apache.olingo.odata2.api.uri.expression">ExpressionKind</a>&nbsp;getKind()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Kind of this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><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></dd>
</dl>
</li>
</ul>
<a name="getEdmType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdmType</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/edm/EdmType.html" title="interface in org.apache.olingo.odata2.api.edm">EdmType</a>&nbsp;getEdmType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The return type of the value represented with
this expression. For example the <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html#getEdmType--"><code>getEdmType()</code></a> method
for an expression representing the "concat" method will return always
"Edm.String".<br>
<br>
<p>This type information is set while parsing the $filter or $orderby
expressions and used to do a first validation of the expression.
For calculating operators like "add, sub, mul" this type
information is purely based on input and output types of the
operator as defined in the OData specification.
So for $filter=2 add 7 the <a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html#getEdmType--"><code>getEdmType()</code></a> method of the binary expression
will return Edm.Byte and not Edm.Int16 because the parser performs no real
addition.<br>
<br>
<p>However, the application may change this type while evaluating the
expression tree.</dd>
</dl>
</li>
</ul>
<a name="setEdmType-org.apache.olingo.odata2.api.edm.EdmType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEdmType</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/CommonExpression.html" title="interface in org.apache.olingo.odata2.api.uri.expression">CommonExpression</a>&nbsp;setEdmType(<a href="../../../../../../../org/apache/olingo/odata2/api/edm/EdmType.html" title="interface in org.apache.olingo.odata2.api.edm">EdmType</a>&nbsp;edmType)</pre>
<div class="block">Set the edmType of this expression node</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edmType</code> - Type to be set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A self reference for method chaining"</dd>
</dl>
</li>
</ul>
<a name="getUriLiteral--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUriLiteral</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;getUriLiteral()</pre>
<div class="block">Returns the URI literal which lead to the creation of this expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URI literal</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/CommonExpression.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/expression/BinaryOperator.html" title="enum in org.apache.olingo.odata2.api.uri.expression"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/expression/ExceptionVisitExpression.html" title="class in org.apache.olingo.odata2.api.uri.expression"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/uri/expression/CommonExpression.html" target="_top">Frames</a></li>
<li><a href="CommonExpression.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-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>