Oracle Coherence for C++ API
Release 3.6.0.0
E15728-01

coherence/util/aggregator/AbstractAggregator.hpp

/*
* AbstractAggregator.hpp
*
* Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_ABSTRACT_AGGREGATOR_HPP
#define COH_ABSTRACT_AGGREGATOR_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/io/pof/PortableObject.hpp"
#include "coherence/util/InvocableMap.hpp"
#include "coherence/util/ValueExtractor.hpp"

COH_OPEN_NAMESPACE3(coherence,util,aggregator)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;
using coherence::io::pof::PortableObject;


/**
* Abstract base class implementation of
* coherence::util::InvocableMap::EntryAggregator that supports
* parallel aggregation.
*
* @author djl  2008.05.09
*/
class COH_EXPORT AbstractAggregator
    : public abstract_spec<AbstractAggregator,
        extends<Object>,
        implements<PortableObject, InvocableMap::ParallelAwareAggregator> >
    {
    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * @internal
        */
        AbstractAggregator();

        /**
        * @internal
        */
        AbstractAggregator(ValueExtractor::View vExtractor);


    // ----- AbstractAggregator Interface  ----------------------------------

    protected:
        /**
        * Initialize the aggregation result.
        *
        * @param fFinal  true is passed if the aggregation process that is
        *                being initialized must produce a final aggregation
        *                result; this will only be false if a parallel
        *                approach is being used and the initial (partial)
        *                aggregation process is being initialized
        */
        virtual void init(bool fFinal) = 0;

        /**
        * Incorporate one aggregatable value into the result.
        *
        * If the <tt>fFinal</tt> parameter is true, the given object is a
        * partial result (returned by an individual parallel aggregator) that
        * should be incorporated into the final result; otherwise, the object
        * is a value extracted from an
        * coherence::util::InvocableMap::Entry.
        *
        * @param vO      the value to incorporate into the aggregated result
        * @param fFinal  true to indicate that the given object is a partial
        *                result returned by a parallel aggregator
        */
        virtual void process(Object::View vO, bool fFinal) = 0;

        /**
        * Obtain the result of the aggregation.
        *
        * If the <tt>fFinal</tt> parameter is true, the returned object must
        * be the final result of the aggregation; otherwise, the returned
        * object will be treated as a partial result that should be
        * incorporated into the final result.
        *
        * @param  fFinal  true to indicate that the final result of the
        *                 aggregation process should be returned; this will
        *                 only be false if a parallel approach is being used
        *
        * @return the result of the aggregation process
        */
        virtual Object::Holder finalizeResult(bool fFinal) = 0;


    // ----- InvocableMap::EntryAggregator interface ------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual Object::Holder aggregate(Set::View vSetEntries);

        /**
        * {@inheritDoc}
        */
        virtual InvocableMap::EntryAggregator::Handle
                getParallelAggregator();

        /**
        * {@inheritDoc}
        */
        virtual Object::Holder aggregateResults(
                Collection::View vCollResults);


    // ----- PortableObject interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void readExternal(PofReader::Handle hIn);

        /**
        * {@inheritDoc}
        */
        virtual void writeExternal(PofWriter::Handle hOut) const;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;

        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- data member accessors ------------------------------------------

    public:
        /**
        * Determine the ValueExtractor whose values this aggregator is
        * aggregating.
        *
        * @return the ValueExtractor used by this aggregator
        */
        virtual ValueExtractor::View getValueExtractor() const;


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * Set to true if this aggregator realizes that it is going to be used
        * in parallel.
        */
        bool m_fParallel;

        /**
        * The ValueExtractor that obtains the value to aggregate from the
        * value that is stored in the Map.
        */
        MemberView<ValueExtractor> m_vExtractor;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_ABSTRACT_AGGREGATOR_HPP

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.