C++ Client API Reference for Oracle Coherence: coherence/util/aggregator/AbstractInteger64Aggregator.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_ABSTRACT_INTEGER64_AGGREGATOR_HPP
00008 #define COH_ABSTRACT_INTEGER64_AGGREGATOR_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/aggregator/AbstractAggregator.hpp"
00013 #include "coherence/util/ValueExtractor.hpp"
00014 
00015 COH_OPEN_NAMESPACE3(coherence,util,aggregator)
00016 
00017 
00018 /**
00019 * Abstract aggregator that processes numeric values extracted from a set of
00020 * entries in a Map. All the extracted Number objects will be treated as
00021 * <tt>int64_t</tt> values and the result of the aggregator is a Integer64.
00022 * If the set of entries is empty, a <tt>NULL</tt> result is returned.
00023 *
00024 * @author djl  2008.05.09
00025 */
00026 class COH_EXPORT AbstractInteger64Aggregator
00027     : public abstract_spec<AbstractInteger64Aggregator,
00028         extends<AbstractAggregator> >
00029     {
00030     // ----- constructors ---------------------------------------------------
00031 
00032     protected:
00033         /**
00034         * @internal
00035         */
00036         AbstractInteger64Aggregator();
00037 
00038         /**
00039         * @internal
00040         */
00041         AbstractInteger64Aggregator(ValueExtractor::View vExtractor);
00042 
00043         /**
00044         * Construct an AbstractInteger64Aggregator that will aggregate 
00045         * values extracted from a set of InvocableMap::Entry objects.
00046         *
00047         * @param vsMethod  the name of the method that could be invoked via
00048         *                  reflection and that returns values to aggregate;
00049         *                  this parameter can also be a dot-delimited 
00050         *                  sequence of method names which would result in
00051         *                  an aggregator based on the ChainedExtractor that
00052         *                  is based on an array of corresponding 
00053         *                  ReflectionExtractor objects
00054         *
00055         * @since Coherence 12.1.2
00056         */
00057         AbstractInteger64Aggregator(String::View vsMethod);
00058 
00059     private:
00060         /**
00061         * Blocked copy constructor.
00062         */
00063         AbstractInteger64Aggregator(const AbstractInteger64Aggregator&);
00064         
00065 
00066     // ----- AbstractAggregator Interface  ----------------------------------
00067 
00068     protected:
00069         /**
00070         * {@inheritDoc}
00071         */
00072         virtual void init(bool fFinal);
00073 
00074         /**
00075         * {@inheritDoc}
00076         */
00077         virtual Object::Holder finalizeResult(bool fFinal);
00078 
00079 
00080     // ----- data members ---------------------------------------------------
00081 
00082     protected:
00083         /**
00084         * The count of processed entries.
00085         */
00086         int32_t m_count;
00087 
00088         /**
00089         * The running result value.
00090         */
00091         int64_t m_lResult;
00092     };
00093 
00094 COH_CLOSE_NAMESPACE3
00095 
00096 #endif // COH_ABSTRACT_INTEGER64_AGGREGATOR_HPP