Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / commons / api / edm / annotation / EdmExpression.html
blob: 6a5349a1463ae24aa8909c564a51cf227cf1a2f5 [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:31 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EdmExpression (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="EdmExpression (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/EdmExpression.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/commons/api/edm/annotation/EdmEq.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/commons/api/edm/annotation/EdmExpression.html" target="_top">Frames</a></li>
<li><a href="EdmExpression.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><a href="#nested.class.summary">Nested</a>&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.commons.api.edm.annotation</div>
<h2 title="Interface EdmExpression" class="title">Interface EdmExpression</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmAnd.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmAnd</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmAnnotationPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmAnnotationPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmApply.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmApply</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmCast.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmCast</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmCollection.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmCollection</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmConstantExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmConstantExpression</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmEq.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmEq</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmGe.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmGe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmGt.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmGt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmIf.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmIf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmIsOf.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmIsOf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmLabeledElement.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmLabeledElement</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmLabeledElementReference.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmLabeledElementReference</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmLe.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmLe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmLogicalOrComparisonExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmLogicalOrComparisonExpression</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmLt.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmLt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmNavigationPropertyPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmNavigationPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmNe.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmNe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmNot.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmNot</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmNull.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmNull</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmOr.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmOr</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmPropertyPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmRecord.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmRecord</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmUrlRef.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmUrlRef</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EdmExpression</span></pre>
<div class="block">Super type of all annotation expressions
A expression is either constant or dynamic</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation">EdmExpression.EdmExpressionType</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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/commons/api/edm/annotation/EdmConstantExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmConstantExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#asConstant--">asConstant</a></span>()</code>
<div class="block">Casts the expression to <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmConstantExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><code>EdmConstantExpression</code></a></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#asDynamic--">asDynamic</a></span>()</code>
<div class="block">Cast the expression to <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><code>EdmDynamicExpression</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/commons/api/edm/annotation/EdmExpression.html#getExpressionName--">getExpressionName</a></span>()</code>
<div class="block">Will return the name of the expression e.g.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation">EdmExpression.EdmExpressionType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#getExpressionType--">getExpressionType</a></span>()</code>
<div class="block">See <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation"><code>EdmExpression.EdmExpressionType</code></a> for details.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#isConstant--">isConstant</a></span>()</code>
<div class="block">Return true if the expression is constant</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#isDynamic--">isDynamic</a></span>()</code>
<div class="block">Return true if the expression is dynamic</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="getExpressionType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpressionType</h4>
<pre><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation">EdmExpression.EdmExpressionType</a>&nbsp;getExpressionType()</pre>
<div class="block">See <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation"><code>EdmExpression.EdmExpressionType</code></a> for details.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of this expression</dd>
</dl>
</li>
</ul>
<a name="getExpressionName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpressionName</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;getExpressionName()</pre>
<div class="block">Will return the name of the expression e.g. Apply or Cast.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the expression</dd>
</dl>
</li>
</ul>
<a name="isConstant--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConstant</h4>
<pre>boolean&nbsp;isConstant()</pre>
<div class="block">Return true if the expression is constant</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the expression is constant</dd>
</dl>
</li>
</ul>
<a name="asConstant--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asConstant</h4>
<pre><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmConstantExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmConstantExpression</a>&nbsp;asConstant()</pre>
<div class="block">Casts the expression to <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmConstantExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><code>EdmConstantExpression</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Constant Expression</dd>
</dl>
</li>
</ul>
<a name="isDynamic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDynamic</h4>
<pre>boolean&nbsp;isDynamic()</pre>
<div class="block">Return true if the expression is dynamic</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the expression is dynamic</dd>
</dl>
</li>
</ul>
<a name="asDynamic--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asDynamic</h4>
<pre><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a>&nbsp;asDynamic()</pre>
<div class="block">Cast the expression to <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><code>EdmDynamicExpression</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Dynamic Expression</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/EdmExpression.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/commons/api/edm/annotation/EdmEq.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/commons/api/edm/annotation/EdmExpression.html" target="_top">Frames</a></li>
<li><a href="EdmExpression.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><a href="#nested.class.summary">Nested</a>&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>