org.apache.hadoop.hbase.client.transactional.TransactionalAggregationClient.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.hadoop.hbase.client.transactional.TransactionalAggregationClient.java

Source

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.hbase.client.transactional;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.NavigableMap;
import java.util.NavigableSet;
import java.util.TreeMap;
import java.util.concurrent.atomic.AtomicLong;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.HConstants;
import org.apache.hadoop.hbase.HRegionInfo;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.client.transactional.TransactionalTable;
import org.apache.hadoop.hbase.client.Result;
import org.apache.hadoop.hbase.client.ResultScanner;
import org.apache.hadoop.hbase.client.Scan;
import org.apache.hadoop.hbase.coprocessor.ColumnInterpreter;
import org.apache.hadoop.hbase.client.coprocessor.Batch;
import org.apache.hadoop.hbase.ipc.BlockingRpcCallback;
import org.apache.hadoop.hbase.ipc.ServerRpcController;
import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
import org.apache.hadoop.hbase.coprocessor.transactional.generated.TrxRegionProtos.*;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.util.Pair;

import com.google.protobuf.ByteString;
import com.google.protobuf.Message;

/**
 * This client class is for invoking the aggregate functions deployed on the
 * Region Server side via the TrxRegionService. This class will implement the
 * supporting functionality for summing/processing the individual results
 * obtained from the TrxRegionService for each region.
 * <p>
 * This will serve as the client side handler for invoking the aggregate
 * functions.
 * <ul>
 * For all aggregate functions,
 * <li>start row < end row is an essential condition (if they are not
 * {@link HConstants#EMPTY_BYTE_ARRAY})
 * <li>Column family can't be null. In case where multiple families are
 * provided, an IOException will be thrown. An optional column qualifier can
 * also be defined.
 * <li>For methods to find maximum, minimum, sum, rowcount, it returns the
 * parameter type. For average and std, it returns a double value. For row
 * count, it returns a long value.
 */
@InterfaceAudience.Private
public class TransactionalAggregationClient {

    private static final Log log = LogFactory.getLog(TransactionalAggregationClient.class);
    Configuration conf;

    /**
     * Constructor with Conf object
     * @param cfg
     */
    public TransactionalAggregationClient(Configuration cfg) {
        this.conf = cfg;
    }

    /**
     * It gives the maximum value of a column for a given column family for the
     * given range. In case qualifier is null, a max of all values for the given
     * family is returned.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return max val <R>
     * @throws Throwable
     *           The caller is supposed to handle the exception as they are thrown
     *           & propagated to it.
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R max(final long transactionId,
            final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return max(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * It gives the maximum value of a column for a given column family for the
     * given range. In case qualifier is null, a max of all values for the given
     * family is returned.
     * @param table
     * @param ci
     * @param scan
     * @return max val <R>
     * @throws Throwable
     *           The caller is supposed to handle the exception as they are thrown
     *           & propagated to it.
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R max(final long transactionId,
            final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);
        class MaxCallBack implements Batch.Callback<R> {
            R max = null;

            R getMax() {
                return max;
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, R result) {
                max = (max == null || (result != null && ci.compare(max, result) < 0)) ? result : max;
            }
        }
        MaxCallBack aMaxCallBack = new MaxCallBack();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, R>() {
                    @Override
                    public R call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getMax(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        if (response.getFirstPartCount() > 0) {
                            ByteString b = response.getFirstPart(0);
                            Q q = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 3, b);
                            return ci.getCellValueFromProto(q);
                        }
                        return null;
                    }
                }, aMaxCallBack);
        return aMaxCallBack.getMax();
    }

    /*
     * @param scan
     * @param canFamilyBeAbsent whether column family can be absent in familyMap of scan
     */
    private void validateParameters(Scan scan, boolean canFamilyBeAbsent) throws IOException {
        if (scan == null
                || (Bytes.equals(scan.getStartRow(), scan.getStopRow())
                        && !Bytes.equals(scan.getStartRow(), HConstants.EMPTY_START_ROW))
                || ((Bytes.compareTo(scan.getStartRow(), scan.getStopRow()) > 0)
                        && !Bytes.equals(scan.getStopRow(), HConstants.EMPTY_END_ROW))) {
            throw new IOException("Agg client Exception: Startrow should be smaller than Stoprow");
        } else if (!canFamilyBeAbsent) {
            if (scan.getFamilyMap().size() != 1) {
                throw new IOException("There must be only one family.");
            }
        }
    }

    /**
     * It gives the minimum value of a column for a given column family for the
     * given range. In case qualifier is null, a min of all values for the given
     * family is returned.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return min val <R>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R min(final long transactionId,
            final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return min(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * It gives the minimum value of a column for a given column family for the
     * given range. In case qualifier is null, a min of all values for the given
     * family is returned.
     * @param table
     * @param ci
     * @param scan
     * @return min val <R>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R min(final long transactionId,
            final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);
        class MinCallBack implements Batch.Callback<R> {

            private R min = null;

            public R getMinimum() {
                return min;
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, R result) {
                min = (min == null || (result != null && ci.compare(result, min) < 0)) ? result : min;
            }
        }
        MinCallBack minCallBack = new MinCallBack();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, R>() {

                    @Override
                    public R call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getMin(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        if (response.getFirstPartCount() > 0) {
                            ByteString b = response.getFirstPart(0);
                            Q q = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 3, b);
                            return ci.getCellValueFromProto(q);
                        }
                        return null;
                    }
                }, minCallBack);
        log.debug("Min fom all regions is: " + minCallBack.getMinimum());
        return minCallBack.getMinimum();
    }

    /**
     * It gives the row count, by summing up the individual results obtained from
     * regions. In case the qualifier is null, FirstKeyValueFilter is used to
     * optimised the operation. In case qualifier is provided, I can't use the
     * filter as it may set the flag to skip to next row, but the value read is
     * not of the given filter: in this case, this particular row will not be
     * counted ==> an error.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> long rowCount(final long transactionId,
            final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return rowCount(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * It gives the row count, by summing up the individual results obtained from
     * regions. In case the qualifier is null, FirstKeyValueFilter is used to
     * optimised the operation. In case qualifier is provided, I can't use the
     * filter as it may set the flag to skip to next row, but the value read is
     * not of the given filter: in this case, this particular row will not be
     * counted ==> an error.
     * @param table
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> long rowCount(final long transactionId,
            final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                true);
        class RowNumCallback implements Batch.Callback<Long> {
            private final AtomicLong rowCountL = new AtomicLong(0);

            public long getRowNumCount() {
                return rowCountL.get();
            }

            @Override
            public void update(byte[] region, byte[] row, Long result) {
                rowCountL.addAndGet(result.longValue());
            }
        }
        RowNumCallback rowNum = new RowNumCallback();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, Long>() {
                    @Override
                    public Long call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getRowNum(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        byte[] bytes = getBytesFromResponse(response.getFirstPart(0));
                        ByteBuffer bb = ByteBuffer.allocate(8).put(bytes);
                        bb.rewind();
                        return bb.getLong();
                    }
                }, rowNum);
        return rowNum.getRowNumCount();
    }

    /**
     * It sums up the value returned from various regions. In case qualifier is
     * null, summation of all the column qualifiers in the given family is done.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return sum <S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> S sum(final long transactionId,
            final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return sum(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * It sums up the value returned from various regions. In case qualifier is
     * null, summation of all the column qualifiers in the given family is done.
     * @param table
     * @param ci
     * @param scan
     * @return sum <S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> S sum(final long transactionId,
            final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci, final Scan scan)
            throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);

        class SumCallBack implements Batch.Callback<S> {
            S sumVal = null;

            public S getSumResult() {
                return sumVal;
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, S result) {
                sumVal = ci.add(sumVal, result);
            }
        }
        SumCallBack sumCallBack = new SumCallBack();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, S>() {
                    @Override
                    public S call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getSum(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        if (response.getFirstPartCount() == 0) {
                            return null;
                        }
                        ByteString b = response.getFirstPart(0);
                        T t = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 4, b);
                        S s = ci.getPromotedValueFromProto(t);
                        return s;
                    }
                }, sumCallBack);
        return sumCallBack.getSumResult();
    }

    /**
     * It computes average while fetching sum and row count from all the
     * corresponding regions. Approach is to compute a global sum of region level
     * sum and rowcount and then compute the average.
     * @param transactionId
     * @param tableName
     * @param scan
     * @throws Throwable
     */
    private <R, S, P extends Message, Q extends Message, T extends Message> Pair<S, Long> getAvgArgs(
            final long transactionId, final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci,
            final Scan scan) throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return getAvgArgs(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * It computes average while fetching sum and row count from all the
     * corresponding regions. Approach is to compute a global sum of region level
     * sum and rowcount and then compute the average.
     * @param table
     * @param scan
     * @throws Throwable
     */
    private <R, S, P extends Message, Q extends Message, T extends Message> Pair<S, Long> getAvgArgs(
            final long transactionId, final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci,
            final Scan scan) throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);
        class AvgCallBack implements Batch.Callback<Pair<S, Long>> {
            S sum = null;
            Long rowCount = 0l;

            public Pair<S, Long> getAvgArgs() {
                return new Pair<S, Long>(sum, rowCount);
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, Pair<S, Long> result) {
                sum = ci.add(sum, result.getFirst());
                rowCount += result.getSecond();
            }
        }
        AvgCallBack avgCallBack = new AvgCallBack();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, Pair<S, Long>>() {
                    @Override
                    public Pair<S, Long> call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getAvg(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        Pair<S, Long> pair = new Pair<S, Long>(null, 0L);
                        if (response.getFirstPartCount() == 0) {
                            return pair;
                        }
                        ByteString b = response.getFirstPart(0);
                        T t = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 4, b);
                        S s = ci.getPromotedValueFromProto(t);
                        pair.setFirst(s);
                        ByteBuffer bb = ByteBuffer.allocate(8).put(getBytesFromResponse(response.getSecondPart()));
                        bb.rewind();
                        pair.setSecond(bb.getLong());
                        return pair;
                    }
                }, avgCallBack);
        return avgCallBack.getAvgArgs();
    }

    /**
     * This is the client side interface/handle for calling the average method for
     * a given cf-cq combination. It was necessary to add one more call stack as
     * its return type should be a decimal value, irrespective of what
     * columninterpreter says. So, this methods collects the necessary parameters
     * to compute the average and returs the double value.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> double avg(final long transactionId,
            final TableName tableName, final ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        Pair<S, Long> p = getAvgArgs(transactionId, tableName, ci, scan);
        return ci.divideForAvg(p.getFirst(), p.getSecond());
    }

    /**
     * This is the client side interface/handle for calling the average method for
     * a given cf-cq combination. It was necessary to add one more call stack as
     * its return type should be a decimal value, irrespective of what
     * columninterpreter says. So, this methods collects the necessary parameters
     * to compute the average and returs the double value.
     * @param table
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> double avg(final long transactionId,
            final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        Pair<S, Long> p = getAvgArgs(transactionId, table, ci, scan);
        return ci.divideForAvg(p.getFirst(), p.getSecond());
    }

    /**
     * It computes a global standard deviation for a given column and its value.
     * Standard deviation is square root of (average of squares -
     * average*average). From individual regions, it obtains sum, square sum and
     * number of rows. With these, the above values are computed to get the global
     * std.
     * @param table
     * @param scan
     * @return standard deviations
     * @throws Throwable
     */
    private <R, S, P extends Message, Q extends Message, T extends Message> Pair<List<S>, Long> getStdArgs(
            final long transactionId, final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci,
            final Scan scan) throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);
        class StdCallback implements Batch.Callback<Pair<List<S>, Long>> {
            long rowCountVal = 0l;
            S sumVal = null, sumSqVal = null;

            public Pair<List<S>, Long> getStdParams() {
                List<S> l = new ArrayList<S>();
                l.add(sumVal);
                l.add(sumSqVal);
                Pair<List<S>, Long> p = new Pair<List<S>, Long>(l, rowCountVal);
                return p;
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, Pair<List<S>, Long> result) {
                if (result.getFirst().size() > 0) {
                    sumVal = ci.add(sumVal, result.getFirst().get(0));
                    sumSqVal = ci.add(sumSqVal, result.getFirst().get(1));
                    rowCountVal += result.getSecond();
                }
            }
        }
        StdCallback stdCallback = new StdCallback();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, Pair<List<S>, Long>>() {
                    @Override
                    public Pair<List<S>, Long> call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getStd(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }
                        Pair<List<S>, Long> pair = new Pair<List<S>, Long>(new ArrayList<S>(), 0L);
                        if (response.getFirstPartCount() == 0) {
                            return pair;
                        }
                        List<S> list = new ArrayList<S>();
                        for (int i = 0; i < response.getFirstPartCount(); i++) {
                            ByteString b = response.getFirstPart(i);
                            T t = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 4, b);
                            S s = ci.getPromotedValueFromProto(t);
                            list.add(s);
                        }
                        pair.setFirst(list);
                        ByteBuffer bb = ByteBuffer.allocate(8).put(getBytesFromResponse(response.getSecondPart()));
                        bb.rewind();
                        pair.setSecond(bb.getLong());
                        return pair;
                    }
                }, stdCallback);
        return stdCallback.getStdParams();
    }

    /**
     * This is the client side interface/handle for calling the std method for a
     * given cf-cq combination. It was necessary to add one more call stack as its
     * return type should be a decimal value, irrespective of what
     * columninterpreter says. So, this methods collects the necessary parameters
     * to compute the std and returns the double value.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> double std(final long transactionId,
            final TableName tableName, ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return std(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * This is the client side interface/handle for calling the std method for a
     * given cf-cq combination. It was necessary to add one more call stack as its
     * return type should be a decimal value, irrespective of what
     * columninterpreter says. So, this methods collects the necessary parameters
     * to compute the std and returns the double value.
     * @param table
     * @param ci
     * @param scan
     * @return <R, S>
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> double std(final long transactionId,
            final TransactionalTable table, ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        Pair<List<S>, Long> p = getStdArgs(transactionId, table, ci, scan);
        double res = 0d;
        double avg = ci.divideForAvg(p.getFirst().get(0), p.getSecond());
        double avgOfSumSq = ci.divideForAvg(p.getFirst().get(1), p.getSecond());
        res = avgOfSumSq - (avg) * (avg); // variance
        res = Math.pow(res, 0.5);
        return res;
    }

    /**
     * It helps locate the region with median for a given column whose weight 
     * is specified in an optional column.
     * From individual regions, it obtains sum of values and sum of weights.
     * @param table
     * @param ci
     * @param scan
     * @return pair whose first element is a map between start row of the region
     *  and (sum of values, sum of weights) for the region, the second element is
     *  (sum of values, sum of weights) for all the regions chosen
     * @throws Throwable
     */
    private <R, S, P extends Message, Q extends Message, T extends Message> Pair<NavigableMap<byte[], List<S>>, List<S>> getMedianArgs(
            final long transactionId, final TransactionalTable table, final ColumnInterpreter<R, S, P, Q, T> ci,
            final Scan scan) throws Throwable {
        byte[] currentBeginKey = scan.getStartRow();
        HRegionInfo currentRegion = table.getRegionLocation(currentBeginKey).getRegionInfo();
        com.google.protobuf.ByteString regionName = ByteString.copyFromUtf8(currentRegion.getRegionNameAsString());
        final TransactionalAggregateRequest requestArg = validateArgAndGetPB(regionName, transactionId, scan, ci,
                false);
        final NavigableMap<byte[], List<S>> map = new TreeMap<byte[], List<S>>(Bytes.BYTES_COMPARATOR);
        class StdCallback implements Batch.Callback<List<S>> {
            S sumVal = null, sumWeights = null;

            public Pair<NavigableMap<byte[], List<S>>, List<S>> getMedianParams() {
                List<S> l = new ArrayList<S>();
                l.add(sumVal);
                l.add(sumWeights);
                Pair<NavigableMap<byte[], List<S>>, List<S>> p = new Pair<NavigableMap<byte[], List<S>>, List<S>>(
                        map, l);
                return p;
            }

            @Override
            public synchronized void update(byte[] region, byte[] row, List<S> result) {
                map.put(row, result);
                sumVal = ci.add(sumVal, result.get(0));
                sumWeights = ci.add(sumWeights, result.get(1));
            }
        }
        StdCallback stdCallback = new StdCallback();
        table.coprocessorService(TrxRegionService.class, scan.getStartRow(), scan.getStopRow(),
                new Batch.Call<TrxRegionService, List<S>>() {
                    @Override
                    public List<S> call(TrxRegionService instance) throws IOException {
                        ServerRpcController controller = new ServerRpcController();
                        BlockingRpcCallback<TransactionalAggregateResponse> rpcCallback = new BlockingRpcCallback<TransactionalAggregateResponse>();
                        instance.getMedian(controller, requestArg, rpcCallback);
                        TransactionalAggregateResponse response = rpcCallback.get();
                        if (controller.failedOnException()) {
                            throw controller.getFailedOn();
                        }

                        List<S> list = new ArrayList<S>();
                        for (int i = 0; i < response.getFirstPartCount(); i++) {
                            ByteString b = response.getFirstPart(i);
                            T t = ProtobufUtil.getParsedGenericInstance(ci.getClass(), 4, b);
                            S s = ci.getPromotedValueFromProto(t);
                            list.add(s);
                        }
                        return list;
                    }

                }, stdCallback);
        return stdCallback.getMedianParams();
    }

    /**
     * This is the client side interface/handler for calling the median method for a
     * given cf-cq combination. This method collects the necessary parameters
     * to compute the median and returns the median.
     * @param transactionId
     * @param tableName
     * @param ci
     * @param scan
     * @return R the median
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R median(final long transactionId,
            final TableName tableName, ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        TransactionalTable table = null;
        try {
            table = new TransactionalTable(tableName.getName());
            return median(transactionId, table, ci, scan);
        } finally {
            if (table != null) {
                table.close();
            }
        }
    }

    /**
     * This is the client side interface/handler for calling the median method for a
     * given cf-cq combination. This method collects the necessary parameters
     * to compute the median and returns the median.
     * @param table
     * @param ci
     * @param scan
     * @return R the median
     * @throws Throwable
     */
    public <R, S, P extends Message, Q extends Message, T extends Message> R median(final long transactionId,
            final TransactionalTable table, ColumnInterpreter<R, S, P, Q, T> ci, Scan scan) throws Throwable {
        Pair<NavigableMap<byte[], List<S>>, List<S>> p = getMedianArgs(transactionId, table, ci, scan);
        byte[] startRow = null;
        byte[] colFamily = scan.getFamilies()[0];
        NavigableSet<byte[]> quals = scan.getFamilyMap().get(colFamily);
        NavigableMap<byte[], List<S>> map = p.getFirst();
        S sumVal = p.getSecond().get(0);
        S sumWeights = p.getSecond().get(1);
        double halfSumVal = ci.divideForAvg(sumVal, 2L);
        double movingSumVal = 0;
        boolean weighted = false;
        if (quals.size() > 1) {
            weighted = true;
            halfSumVal = ci.divideForAvg(sumWeights, 2L);
        }

        for (Map.Entry<byte[], List<S>> entry : map.entrySet()) {
            S s = weighted ? entry.getValue().get(1) : entry.getValue().get(0);
            double newSumVal = movingSumVal + ci.divideForAvg(s, 1L);
            if (newSumVal > halfSumVal)
                break; // we found the region with the median
            movingSumVal = newSumVal;
            startRow = entry.getKey();
        }
        // scan the region with median and find it
        Scan scan2 = new Scan(scan);
        // inherit stop row from method parameter
        if (startRow != null)
            scan2.setStartRow(startRow);
        ResultScanner scanner = null;
        try {
            int cacheSize = scan2.getCaching();
            if (!scan2.getCacheBlocks() || scan2.getCaching() < 2) {
                scan2.setCacheBlocks(true);
                cacheSize = 5;
                scan2.setCaching(cacheSize);
            }
            scanner = table.getScanner(scan2);
            Result[] results = null;
            byte[] qualifier = quals.pollFirst();
            // qualifier for the weight column
            byte[] weightQualifier = weighted ? quals.pollLast() : qualifier;
            R value = null;
            do {
                results = scanner.next(cacheSize);
                if (results != null && results.length > 0) {
                    for (int i = 0; i < results.length; i++) {
                        Result r = results[i];
                        // retrieve weight
                        Cell kv = r.getColumnLatest(colFamily, weightQualifier);
                        R newValue = ci.getValue(colFamily, weightQualifier, kv);
                        S s = ci.castToReturnType(newValue);
                        double newSumVal = movingSumVal + ci.divideForAvg(s, 1L);
                        // see if we have moved past the median
                        if (newSumVal > halfSumVal) {
                            return value;
                        }
                        movingSumVal = newSumVal;
                        kv = r.getColumnLatest(colFamily, qualifier);
                        value = ci.getValue(colFamily, qualifier, kv);
                    }
                }
            } while (results != null && results.length > 0);
        } finally {
            if (scanner != null) {
                scanner.close();
            }
        }
        return null;
    }

    <R, S, P extends Message, Q extends Message, T extends Message> TransactionalAggregateRequest validateArgAndGetPB(
            com.google.protobuf.ByteString regionName, long transactionId, Scan scan,
            ColumnInterpreter<R, S, P, Q, T> ci, boolean canFamilyBeAbsent) throws IOException {
        validateParameters(scan, canFamilyBeAbsent);
        final TransactionalAggregateRequest.Builder requestBuilder = TransactionalAggregateRequest.newBuilder();
        requestBuilder.setInterpreterClassName(ci.getClass().getCanonicalName());
        P columnInterpreterSpecificData = null;
        if ((columnInterpreterSpecificData = ci.getRequestData()) != null) {
            requestBuilder.setInterpreterSpecificBytes(columnInterpreterSpecificData.toByteString());
        }
        requestBuilder.setScan(ProtobufUtil.toScan(scan));
        requestBuilder.setTransactionId(transactionId);
        requestBuilder.setRegionName(regionName);
        return requestBuilder.build();
    }

    byte[] getBytesFromResponse(ByteString response) {
        ByteBuffer bb = response.asReadOnlyByteBuffer();
        bb.rewind();
        byte[] bytes;
        if (bb.hasArray()) {
            bytes = bb.array();
        } else {
            bytes = response.toByteArray();
        }
        return bytes;
    }
}