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

E69640-01

coherence/util/aggregator/CompositeAggregator.hpp

00001 /*
00002 * CompositeAggregator.hpp
00003 *
00004 * Copyright (c) 2000, 2016, 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_COMPOSITE_AGGREGATOR_HPP
00017 #define COH_COMPOSITE_AGGREGATOR_HPP
00018 
00019 #include "coherence/lang.ns"
00020 
00021 #include "coherence/io/pof/PofReader.hpp"
00022 #include "coherence/io/pof/PofWriter.hpp"
00023 #include "coherence/io/pof/PortableObject.hpp"
00024 #include "coherence/util/InvocableMap.hpp"
00025 
00026 COH_OPEN_NAMESPACE3(coherence,util,aggregator)
00027 
00028 using coherence::io::pof::PofReader;
00029 using coherence::io::pof::PofWriter;
00030 using coherence::io::pof::PortableObject;
00031 
00032 
00033 /**
00034 * CompositeAggregator provides an ability to execute a collection of
00035 * aggregators against the same subset of the entries in an InvocableMap,
00036 * resulting in a list of corresponding aggregation results. The size of the
00037 * returned list will always be equal to the length of the aggregators' array.
00038 *
00039 * @author djl  2008.05.16
00040 */
00041 class COH_EXPORT CompositeAggregator
00042     : public class_spec<CompositeAggregator,
00043         extends<Object>,
00044         implements<PortableObject, InvocableMap::EntryAggregator> >
00045     {
00046     friend class factory<CompositeAggregator>;
00047 
00048     // ----- factory methods ------------------------------------------------
00049 
00050     public:
00051          /**
00052          * Default constructor (necessary for the PortableObject interface).
00053          */
00054          static CompositeAggregator::Handle create();
00055 
00056          /**
00057          * Create an instance of CompositeAggregator based on a specified
00058          * array of coherence::util::InvocableMap::EntryAggregator.
00059          *
00060          * @param vaAggregator  an array of EntryAggregator objects; must
00061          *                      contain not less than two aggregators
00062          */
00063          static CompositeAggregator::Handle create(
00064                  ObjectArray::View vaAggregator);
00065 
00066 
00067     // ----- constructors ---------------------------------------------------
00068 
00069     protected:
00070         /**
00071         * @internal
00072         */
00073         CompositeAggregator();
00074 
00075         /**
00076         * @internal
00077         */
00078         CompositeAggregator(ObjectArray::View vaAggregator);
00079 
00080     private:
00081         /**
00082         * Blocked copy constructor.
00083         */
00084         CompositeAggregator(const CompositeAggregator&);
00085 
00086 
00087     // ----- InvocableMap::EntryAggregator interface ------------------------
00088 
00089     public:
00090         /**
00091         * {@inheritDoc}
00092         */
00093         virtual Object::Holder aggregate(Set::View vSetEntries);
00094 
00095 
00096     // ----- PortableObject interface ---------------------------------------
00097 
00098     public:
00099         /**
00100         * {@inheritDoc}
00101         */
00102         virtual void readExternal(PofReader::Handle hIn);
00103 
00104         /**
00105         * {@inheritDoc}
00106         */
00107         virtual void writeExternal(PofWriter::Handle hOut) const;
00108 
00109 
00110     // ----- Object interface -----------------------------------------------
00111 
00112     public:
00113         /**
00114         * {@inheritDoc}
00115         */
00116         virtual bool equals(Object::View v) const;
00117 
00118         /**
00119         * {@inheritDoc}
00120         */
00121         virtual size32_t hashCode() const;
00122 
00123         /**
00124         * {@inheritDoc}
00125         */
00126         virtual TypedHandle<const String> toString() const;
00127 
00128 
00129     // ----- data member accessors ------------------------------------------
00130 
00131     public:
00132         /**
00133         * Determine the ValueExtractor whose values this aggregator is
00134         * aggregating.
00135         *
00136         * @return the ValueExtractor used by this aggregator
00137         */
00138         virtual ObjectArray::View getAggregators() const;
00139 
00140 
00141     // ----- data members ---------------------------------------------------
00142 
00143     protected:
00144         /**
00145         * The underlying EntryAggregator array.
00146         */
00147         FinalView<ObjectArray> f_vaAggregator;
00148     };
00149 
00150 COH_CLOSE_NAMESPACE3
00151 
00152 #endif // COH_COMPOSITE_AGGREGATOR_HPP
Copyright © 2000, 2016, Oracle and/or its affiliates. All rights reserved.