arq/org.apache.jena.arq/org/apache/jena/sparql/expr/aggregate/Aggregator.html - jena-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Aggregator (Apache Jena ARQ)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: module: org.apache.jena.arq, package: org.apache.jena.sparql.expr.aggregate, interface: Aggregator">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../../module-summary.html">Module</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/Aggregator.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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <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="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">org.apache.jena.arq</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.sparql.expr.aggregate</a></div>
 <h1 title="Interface Aggregator" class="title">Interface Aggregator</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="AggAvg.html" title="class in org.apache.jena.sparql.expr.aggregate">AggAvg</a></code>, <code><a href="AggAvgDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggAvgDistinct</a></code>, <code><a href="AggCount.html" title="class in org.apache.jena.sparql.expr.aggregate">AggCount</a></code>, <code><a href="AggCountDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggCountDistinct</a></code>, <code><a href="AggCountVar.html" title="class in org.apache.jena.sparql.expr.aggregate">AggCountVar</a></code>, <code><a href="AggCountVarDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggCountVarDistinct</a></code>, <code><a href="AggCustom.html" title="class in org.apache.jena.sparql.expr.aggregate">AggCustom</a></code>, <code><a href="AggGroupConcat.html" title="class in org.apache.jena.sparql.expr.aggregate">AggGroupConcat</a></code>, <code><a href="AggGroupConcatDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggGroupConcatDistinct</a></code>, <code><a href="AggMax.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMax</a></code>, <code><a href="AggMaxDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMaxDistinct</a></code>, <code><a href="AggMedian.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMedian</a></code>, <code><a href="AggMedianDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMedianDistinct</a></code>, <code><a href="AggMin.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMin</a></code>, <code><a href="AggMinDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMinDistinct</a></code>, <code><a href="AggMode.html" title="class in org.apache.jena.sparql.expr.aggregate">AggMode</a></code>, <code><a href="AggModeDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggModeDistinct</a></code>, <code><a href="AggNull.html" title="class in org.apache.jena.sparql.expr.aggregate">AggNull</a></code>, <code><a href="AggregatorBase.html" title="class in org.apache.jena.sparql.expr.aggregate">AggregatorBase</a></code>, <code><a href="AggSample.html" title="class in org.apache.jena.sparql.expr.aggregate">AggSample</a></code>, <code><a href="AggSampleDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggSampleDistinct</a></code>, <code><a href="AggSum.html" title="class in org.apache.jena.sparql.expr.aggregate">AggSum</a></code>, <code><a href="AggSumDistinct.html" title="class in org.apache.jena.sparql.expr.aggregate">AggSumDistinct</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Aggregator</span></div>
 <div class="block">An Aggregator is the processor for the whole result stream.
   BindingKeys identify which section of a group we're in.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#asSparqlExpr(org.apache.jena.sparql.serializer.SerializationContext)" class="member-name-link">asSparqlExpr</a><wbr>(<a href="../../serializer/SerializationContext.html" title="class in org.apache.jena.sparql.serializer">SerializationContext</a>&nbsp;sCxt)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Format as an (extended) SPARQL expression</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copy(org.apache.jena.sparql.expr.ExprList)" class="member-name-link">copy</a><wbr>(<a href="../ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a>&nbsp;exprs)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copyTransform(org.apache.jena.sparql.graph.NodeTransform)" class="member-name-link">copyTransform</a><wbr>(<a href="../../graph/NodeTransform.html" title="interface in org.apache.jena.sparql.graph">NodeTransform</a>&nbsp;transform)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Accumulator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Accumulator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createAccumulator()" class="member-name-link">createAccumulator</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Create an accumulator for this aggregator</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;other)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#equals(org.apache.jena.sparql.expr.aggregate.Aggregator,boolean)" class="member-name-link">equals</a><wbr>(<a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a>&nbsp;other,
  boolean&nbsp;bySyntax)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Consider this 'protected'</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getExprList()" class="member-name-link">getExprList</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Get the SPARQL name (COUNT, AVG etc)</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.jena.graph.Node</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueEmpty()" class="member-name-link">getValueEmpty</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Value if there are no groups : return null for no result</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#key()" class="member-name-link">key</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toPrefixString()" class="member-name-link">toPrefixString</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 </div>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="createAccumulator()">
 <h3>createAccumulator</h3>
 <div class="member-signature"><span class="return-type"><a href="Accumulator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Accumulator</a></span>&nbsp;<span class="element-name">createAccumulator</span>()</div>
 <div class="block">Create an accumulator for this aggregator</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getValueEmpty()">
 <h3>getValueEmpty</h3>
 <div class="member-signature"><span class="return-type">org.apache.jena.graph.Node</span>&nbsp;<span class="element-name">getValueEmpty</span>()</div>
 <div class="block">Value if there are no groups : return null for no result</div>
 </section>
 </li>
 <li>
 <section class="detail" id="toPrefixString()">
 <h3>toPrefixString</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toPrefixString</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="key()">
 <h3>key</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">key</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getName()">
 <h3>getName</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
 <div class="block">Get the SPARQL name (COUNT, AVG etc)</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getExprList()">
 <h3>getExprList</h3>
 <div class="member-signature"><span class="return-type"><a href="../ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a></span>&nbsp;<span class="element-name">getExprList</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="copy(org.apache.jena.sparql.expr.ExprList)">
 <h3>copy</h3>
 <div class="member-signature"><span class="return-type"><a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a></span>&nbsp;<span class="element-name">copy</span><wbr><span class="parameters">(<a href="../ExprList.html" title="class in org.apache.jena.sparql.expr">ExprList</a>&nbsp;exprs)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="copyTransform(org.apache.jena.sparql.graph.NodeTransform)">
 <h3>copyTransform</h3>
 <div class="member-signature"><span class="return-type"><a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a></span>&nbsp;<span class="element-name">copyTransform</span><wbr><span class="parameters">(<a href="../../graph/NodeTransform.html" title="interface in org.apache.jena.sparql.graph">NodeTransform</a>&nbsp;transform)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="hashCode()">
 <h3>hashCode</h3>
 <div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equals(java.lang.Object)">
 <h3>equals</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;other)</span></div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equals(org.apache.jena.sparql.expr.aggregate.Aggregator,boolean)">
 <h3>equals</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="Aggregator.html" title="interface in org.apache.jena.sparql.expr.aggregate">Aggregator</a>&nbsp;other,
  boolean&nbsp;bySyntax)</span></div>
 <div class="block">Consider this 'protected'</div>
 </section>
 </li>
 <li>
 <section class="detail" id="asSparqlExpr(org.apache.jena.sparql.serializer.SerializationContext)">
 <h3>asSparqlExpr</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">asSparqlExpr</span><wbr><span class="parameters">(<a href="../../serializer/SerializationContext.html" title="class in org.apache.jena.sparql.serializer">SerializationContext</a>&nbsp;sCxt)</span></div>
 <div class="block">Format as an (extended) SPARQL expression</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>