blob: 9a8f8f83fd7b485f61ee2ed8f00672098996b6ad [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AggregateImplementation (Apache HBase 3.0.0-SNAPSHOT API)</title>
<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="AggregateImplementation (Apache HBase 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/AggregateImplementation.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html" title="class in org.apache.hadoop.hbase.coprocessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" target="_top">Frames</a></li>
<li><a href="AggregateImplementation.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.classes.inherited.from.class.org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.hadoop.hbase.coprocessor</div>
<h2 title="Class AggregateImplementation" class="title">Class AggregateImplementation&lt;T,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,R extends com.google.protobuf.Message&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.coprocessor.AggregateImplementation&lt;T,S,P,Q,R&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.google.protobuf.Service, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.63">AggregateImplementation</a>&lt;T,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,R extends com.google.protobuf.Message&gt;
extends org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService
implements <a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></pre>
<div class="block">A concrete AggregateProtocol implementation. Its system level coprocessor
that computes the aggregate function at a region level.
<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ColumnInterpreter.html" title="class in org.apache.hadoop.hbase.coprocessor"><code>ColumnInterpreter</code></a> is used to interpret column value. This class is
parameterized with the following (these are the types with which the <a href="../../../../../org/apache/hadoop/hbase/coprocessor/ColumnInterpreter.html" title="class in org.apache.hadoop.hbase.coprocessor"><code>ColumnInterpreter</code></a>
is parameterized, and for more description on these, refer to <a href="../../../../../org/apache/hadoop/hbase/coprocessor/ColumnInterpreter.html" title="class in org.apache.hadoop.hbase.coprocessor"><code>ColumnInterpreter</code></a>):</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</h3>
<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService.BlockingInterface, org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService.Interface, org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService.Stub</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.Coprocessor">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.hadoop.hbase.<a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.State.html" title="enum in org.apache.hadoop.hbase">Coprocessor.State</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessorEnvironment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#env">env</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#log">log</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.Coprocessor">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.hadoop.hbase.<a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_HIGHEST">PRIORITY_HIGHEST</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_LOWEST">PRIORITY_LOWEST</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_SYSTEM">PRIORITY_SYSTEM</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_USER">PRIORITY_USER</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#VERSION">VERSION</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#AggregateImplementation--">AggregateImplementation</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>(package private) <a href="../../../../../org/apache/hadoop/hbase/coprocessor/ColumnInterpreter.html" title="class in org.apache.hadoop.hbase.coprocessor">ColumnInterpreter</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">T</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">S</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">P</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">Q</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">R</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#constructColumnInterpreterFromRequest-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-">constructColumnInterpreterFromRequest</a></span>(org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getAvg-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getAvg</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives a Pair with first object as Sum and second object as row count,
computed for a given combination of column qualifier and column family in
the given row range as defined in the Scan object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getMax-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getMax</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives the maximum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getMedian-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getMedian</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives a List containing sum of values and sum of weights.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getMin-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getMin</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives the minimum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getRowNum-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getRowNum</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives the row count for the given column family and column qualifier, in
the given row range as defined in the Scan object.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;com.google.protobuf.Service&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getServices--">getServices</a></span>()</code>
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getStd-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getStd</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives a Pair with first object a List containing Sum and sum of squares,
and the second object as row count.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#getSum-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">getSum</a></span>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</code>
<div class="block">Gives the sum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#start-org.apache.hadoop.hbase.CoprocessorEnvironment-">start</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</code>
<div class="block">Stores a reference to the coprocessor environment provided by the
<a href="../../../../../org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver"><code>RegionCoprocessorHost</code></a> from the region where this
coprocessor is loaded.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">stop</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)</code>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the
coprocessor.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</h3>
<code>callMethod, getDescriptor, getDescriptorForType, getRequestPrototype, getResponsePrototype, newBlockingStub, newReflectiveBlockingService, newReflectiveService, newStub</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.coprocessor.RegionCoprocessor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.hbase.coprocessor.<a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#getBulkLoadObserver--">getBulkLoadObserver</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#getEndpointObserver--">getEndpointObserver</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#getRegionObserver--">getRegionObserver</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="log">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>protected static final&nbsp;org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.65">log</a></pre>
</li>
</ul>
<a name="env">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>env</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessorEnvironment</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.66">env</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AggregateImplementation--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AggregateImplementation</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.63">AggregateImplementation</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMax-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMax</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.76">getMax</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives the maximum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object. In its
current implementation, it takes one column family and one column qualifier
(if provided). In case of null column qualifier, maximum value for the
entire column family will be returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getMax</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getMin-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMin</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.131">getMin</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives the minimum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object. In its
current implementation, it takes one column family and one column qualifier
(if provided). In case of null column qualifier, minimum value for the
entire column family will be returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getMin</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getSum-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSum</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.184">getSum</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives the sum for a given combination of column qualifier and column
family, in the given row range as defined in the Scan object. In its
current implementation, it takes one column family and one column qualifier
(if provided). In case of null column qualifier, sum for the entire column
family will be returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSum</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getRowNum-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowNum</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.237">getRowNum</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives the row count for the given column family and column qualifier, in
the given row range as defined in the Scan object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getRowNum</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getAvg-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvg</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.297">getAvg</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives a Pair with first object as Sum and second object as row count,
computed for a given combination of column qualifier and column family in
the given row range as defined in the Scan object. In its current
implementation, it takes one column family and one column qualifier (if
provided). In case of null column qualifier, an aggregate sum over all the
entire column family will be returned.
<p>
The average is computed in
AggregationClient#avg(byte[], ColumnInterpreter, Scan) by
processing results from all regions, so its "ok" to pass sum and a Long
type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAvg</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getStd-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStd</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.357">getStd</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives a Pair with first object a List containing Sum and sum of squares,
and the second object as row count. It is computed for a given combination of
column qualifier and column family in the given row range as defined in the
Scan object. In its current implementation, it takes one column family and
one column qualifier (if provided). The idea is get the value of variance first:
the average of the squares less the square of the average a standard
deviation is square root of variance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getStd</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="getMedian-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-com.google.protobuf.RpcCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMedian</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.422">getMedian</a>(com.google.protobuf.RpcController&nbsp;controller,
org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request,
com.google.protobuf.RpcCallback&lt;org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateResponse&gt;&nbsp;done)</pre>
<div class="block">Gives a List containing sum of values and sum of weights.
It is computed for the combination of column
family and column qualifier(s) in the given row range as defined in the
Scan object. In its current implementation, it takes one column family and
two column qualifiers. The first qualifier is for values column and
the second qualifier (optional) is for weight column.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getMedian</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService</code></dd>
</dl>
</li>
</ul>
<a name="constructColumnInterpreterFromRequest-org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructColumnInterpreterFromRequest</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/coprocessor/ColumnInterpreter.html" title="class in org.apache.hadoop.hbase.coprocessor">ColumnInterpreter</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">T</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">S</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">P</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">Q</a>,<a href="../../../../../org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" title="type parameter in AggregateImplementation">R</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.482">constructColumnInterpreterFromRequest</a>(org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateRequest&nbsp;request)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getServices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServices</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;com.google.protobuf.Service&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.503">getServices</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#getServices--">Coprocessor</a></code></span></div>
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#getServices--">getServices</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterable of <code>Service</code>s or empty collection. Implementations should never
return null.</dd>
</dl>
</li>
</ul>
<a name="start-org.apache.hadoop.hbase.CoprocessorEnvironment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.518">start</a>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Stores a reference to the coprocessor environment provided by the
<a href="../../../../../org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver"><code>RegionCoprocessorHost</code></a> from the region where this
coprocessor is loaded. Since this is a coprocessor endpoint, it always expects to be loaded
on a table region, so always expects this to be an instance of
<a href="../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor"><code>RegionCoprocessorEnvironment</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#start-org.apache.hadoop.hbase.CoprocessorEnvironment-">start</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - the environment provided by the coprocessor host</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the provided environment is not an instance of
<code>RegionCoprocessorEnvironment</code></dd>
</dl>
</li>
</ul>
<a name="stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html#line.527">stop</a>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a>&nbsp;env)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">Coprocessor</a></code></span></div>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the
coprocessor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></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/AggregateImplementation.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html" title="class in org.apache.hadoop.hbase.coprocessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/coprocessor/AggregateImplementation.html" target="_top">Frames</a></li>
<li><a href="AggregateImplementation.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.classes.inherited.from.class.org.apache.hadoop.hbase.protobuf.generated.AggregateProtos.AggregateService">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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; 2007&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>