Google Git
Sign in
apache / olingo-site / fe6108cdb29457195fe60b074e028fa68b5a2c1c / . / output / javadoc / odata4 / org / apache / olingo / server / api / uri / queryoption / apply / AggregateExpression.html
blob: 49562057d04b74ad2a5ea2fe0e990cfd9a44c0db [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:35 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AggregateExpression (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="AggregateExpression (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/AggregateExpression.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/uri/queryoption/apply/Aggregate.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" target="_top">Frames</a></li>
<li><a href="AggregateExpression.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.server.api.uri.queryoption.apply</div>
<h2 title="Interface AggregateExpression" class="title">Interface AggregateExpression</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AggregateExpression</span></pre>
<div class="block">Represents an aggregate expression.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/Aggregate.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply"><code>Aggregate</code></a></dd>
</dl>
</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/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression.StandardMethod</a></span></code>
<div class="block">Standard aggregation method.</div>
</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="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/server/api/uri/queryoption/apply/AggregateExpression.html#getAlias--">getAlias</a></span>()</code>
<div class="block">Gets the name of the aggregate if an alias name has been set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getCustomMethod--">getCustomMethod</a></span>()</code>
<div class="block">Gets the name of the custom aggregation method if used.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/expression/Expression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.expression">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getExpression--">getExpression</a></span>()</code>
<div class="block">Gets the common expression to be aggregated.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getFrom--">getFrom</a></span>()</code>
<div class="block">Gets the aggregate expressions for <code>from</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getInlineAggregateExpression--">getInlineAggregateExpression</a></span>()</code>
<div class="block">Gets the inline aggregation expression to be applied to the target of the path if used.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/server/api/uri/UriResource.html" title="interface in org.apache.olingo.server.api.uri">UriResource</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getPath--">getPath</a></span>()</code>
<div class="block">Gets the path prefix and the path segment.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression.StandardMethod</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getStandardMethod--">getStandardMethod</a></span>()</code>
<div class="block">Gets the standard aggregation method if used.</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="getPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/server/api/uri/UriResource.html" title="interface in org.apache.olingo.server.api.uri">UriResource</a>&gt;&nbsp;getPath()</pre>
<div class="block">Gets the path prefix and the path segment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a (potentially empty) list of path segments (and never <code>null</code>)</dd>
</dl>
</li>
</ul>
<a name="getExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/expression/Expression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.expression">Expression</a>&nbsp;getExpression()</pre>
<div class="block">Gets the common expression to be aggregated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/expression/Expression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.expression"><code>Expression</code></a> that could be <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getStandardMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStandardMethod</h4>
<pre><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression.StandardMethod</a>&nbsp;getStandardMethod()</pre>
<div class="block">Gets the standard aggregation method if used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply"><code>AggregateExpression.StandardMethod</code></a> or <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getCustomMethod--"><code>getCustomMethod()</code></a></dd>
</dl>
</li>
</ul>
<a name="getCustomMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomMethod</h4>
<pre><a href="../../../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a>&nbsp;getCustomMethod()</pre>
<div class="block">Gets the name of the custom aggregation method if used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm"><code>FullQualifiedName</code></a> or <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getStandardMethod--"><code>getStandardMethod()</code></a></dd>
</dl>
</li>
</ul>
<a name="getAlias--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlias</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;getAlias()</pre>
<div class="block">Gets the name of the aggregate if an alias name has been set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an identifier String or <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getInlineAggregateExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInlineAggregateExpression</h4>
<pre><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression</a>&nbsp;getInlineAggregateExpression()</pre>
<div class="block">Gets the inline aggregation expression to be applied to the target of the path if used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an aggregation expression or <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html#getPath--"><code>getPath()</code></a></dd>
</dl>
</li>
</ul>
<a name="getFrom--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFrom</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply">AggregateExpression</a>&gt;&nbsp;getFrom()</pre>
<div class="block">Gets the aggregate expressions for <code>from</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a (potentially empty) list of aggregate expressions (but never <code>null</code>)</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/AggregateExpression.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/uri/queryoption/apply/Aggregate.html" title="interface in org.apache.olingo.server.api.uri.queryoption.apply"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.StandardMethod.html" title="enum in org.apache.olingo.server.api.uri.queryoption.apply"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/apply/AggregateExpression.html" target="_top">Frames</a></li>
<li><a href="AggregateExpression.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>