C++ Client API Reference for Oracle Coherence: coherence/util/aggregator/ParallelCompositeAggregator.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_PARALLEL_COMPOSITE_AGGREGATOR_HPP
00008 #define COH_PARALLEL_COMPOSITE_AGGREGATOR_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/aggregator/CompositeAggregator.hpp"
00013 #include "coherence/util/InvocableMap.hpp"
00014 
00015 COH_OPEN_NAMESPACE3(coherence,util,aggregator)
00016 
00017 
00018 /**
00019 * ParallelCompositeAggregator provides an ability to execute a collection of
00020 * parallel aware aggregators against the same subset of the entries in an
00021 * InvocableMap, resulting in a list of corresponding aggregation results. The
00022 * size of the returned list will always be equal to the length of the
00023 * aggregators' array.
00024 *
00025 * Unlike many other concrete EntryAggregator implementations that are
00026 * constructed directly, instances of ParallelCompositeAggregator should only
00027 * becreated indirectly by using the factory method of CompositeAggregator.
00028 *
00029 * @deprecated as of Coherence 12.2.1
00030 *
00031 * @author djl  2008.05.16
00032 */
00033 class COH_EXPORT ParallelCompositeAggregator
00034     : public class_spec<ParallelCompositeAggregator,
00035         extends<CompositeAggregator>,
00036         implements<InvocableMap::ParallelAwareAggregator> >
00037     {
00038     friend class factory<ParallelCompositeAggregator>;
00039 
00040     // ----- constructors ---------------------------------------------------
00041 
00042     protected:
00043         /**
00044         * Default constructor (necessary for the PortableObject
00045         * interface).
00046         */
00047         ParallelCompositeAggregator();
00048 
00049         /**
00050         * Construct a ParallelCompositeAggregator based on a
00051         * specified
00052         * coherence::util::InvocableMap::EntryAggregator array.
00053         *
00054         * @param vaAggregator  an array of ParallelAwareAggregator
00055         *                      objects; may not be null
00056         */
00057         ParallelCompositeAggregator(ObjectArray::View vaAggregator);
00058 
00059     private:
00060         /**
00061         * Blocked copy constructor.
00062         */
00063         ParallelCompositeAggregator(const ParallelCompositeAggregator&);
00064 
00065 
00066     // ----- InvocableMap::ParallelAwareAggregator interface ----------------
00067 
00068     public:
00069         /**
00070         * {@inheritDoc}
00071         */
00072         virtual InvocableMap::EntryAggregator::Handle
00073                 getParallelAggregator();
00074 
00075         /**
00076         * {@inheritDoc}
00077         */
00078         virtual Object::Holder aggregateResults(
00079                 Collection::View vCollResults);
00080     };
00081 
00082 COH_CLOSE_NAMESPACE3
00083 
00084 #endif // COH_PARALLEL_COMPOSITE_AGGREGATOR_HPP