Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.4.0)

E90870-01

coherence/util/aggregator/ParallelCompositeAggregator.hpp

00001 /*
00002 * ParallelCompositeAggregator.hpp
00003 *
00004 * Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
00005 *
00006 * Oracle is a registered trademarks of Oracle Corporation and/or its
00007 * affiliates.
00008 *
00009 * This software is the confidential and proprietary information of Oracle
00010 * Corporation. You shall not disclose such confidential and proprietary
00011 * information and shall use it only in accordance with the terms of the
00012 * license agreement you entered into with Oracle.
00013 *
00014 * This notice may not be removed or altered.
00015 */
00016 #ifndef COH_PARALLEL_COMPOSITE_AGGREGATOR_HPP
00017 #define COH_PARALLEL_COMPOSITE_AGGREGATOR_HPP
00018 
00019 #include "coherence/lang.ns"
00020 
00021 #include "coherence/util/aggregator/CompositeAggregator.hpp"
00022 #include "coherence/util/InvocableMap.hpp"
00023 
00024 COH_OPEN_NAMESPACE3(coherence,util,aggregator)
00025 
00026 
00027 /**
00028 * ParallelCompositeAggregator provides an ability to execute a collection of
00029 * parallel aware aggregators against the same subset of the entries in an
00030 * InvocableMap, resulting in a list of corresponding aggregation results. The
00031 * size of the returned list will always be equal to the length of the
00032 * aggregators' array.
00033 *
00034 * Unlike many other concrete EntryAggregator implementations that are
00035 * constructed directly, instances of ParallelCompositeAggregator should only
00036 * becreated indirectly by using the factory method of CompositeAggregator.
00037 *
00038 * @deprecated as of Coherence 12.2.1
00039 *
00040 * @author djl  2008.05.16
00041 */
00042 class COH_EXPORT ParallelCompositeAggregator
00043     : public class_spec<ParallelCompositeAggregator,
00044         extends<CompositeAggregator>,
00045         implements<InvocableMap::ParallelAwareAggregator> >
00046     {
00047     friend class factory<ParallelCompositeAggregator>;
00048 
00049     // ----- constructors ---------------------------------------------------
00050 
00051     protected:
00052         /**
00053         * Default constructor (necessary for the PortableObject
00054         * interface).
00055         */
00056         ParallelCompositeAggregator();
00057 
00058         /**
00059         * Construct a ParallelCompositeAggregator based on a
00060         * specified
00061         * coherence::util::InvocableMap::EntryAggregator array.
00062         *
00063         * @param vaAggregator  an array of ParallelAwareAggregator
00064         *                      objects; may not be null
00065         */
00066         ParallelCompositeAggregator(ObjectArray::View vaAggregator);
00067 
00068     private:
00069         /**
00070         * Blocked copy constructor.
00071         */
00072         ParallelCompositeAggregator(const ParallelCompositeAggregator&);
00073 
00074 
00075     // ----- InvocableMap::ParallelAwareAggregator interface ----------------
00076 
00077     public:
00078         /**
00079         * {@inheritDoc}
00080         */
00081         virtual InvocableMap::EntryAggregator::Handle
00082                 getParallelAggregator();
00083 
00084         /**
00085         * {@inheritDoc}
00086         */
00087         virtual Object::Holder aggregateResults(
00088                 Collection::View vCollResults);
00089     };
00090 
00091 COH_CLOSE_NAMESPACE3
00092 
00093 #endif // COH_PARALLEL_COMPOSITE_AGGREGATOR_HPP
Copyright © 2000, 2019, Oracle and/or its affiliates. All rights reserved.