Oracle Coherence for C++ API
Release 3.7.1.0
E22845-01

coherence/util/filter/MapEventTransformerFilter.hpp

/*
* MapEventTransformerFilter.hpp
*
* Copyright (c) 2000, 2011, 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_MAP_EVENT_TRANSFORMER_FILTER_HPP
#define COH_MAP_EVENT_TRANSFORMER_FILTER_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/Filter.hpp"
#include "coherence/util/MapEvent.hpp"
#include "coherence/util/MapEventTransformer.hpp"
#include "coherence/util/MapTrigger.hpp"

COH_OPEN_NAMESPACE3(coherence,util,filter)

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


/**
* MapEventTransformerFilter is a generic multiplexing wrapper that combines
* two implementations: a Filter (most commonly a MapEventFilter) and
* a MapEventTransformer and is used to register event listeners that allow to
* change the content of a MapEvent.
*
* @see coherence::util::transformer::SemiLiteEventTransformer
*
* @author djl  2008.05.22
*/
class COH_EXPORT MapEventTransformerFilter
    : public class_spec<MapEventTransformerFilter,
        extends<Object>,
        implements<PortableObject, Filter, MapEventTransformer> >
    {
    friend class factory<MapEventTransformerFilter>;

    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Default constructor (necessary for the PortableObject interface).
        */
        MapEventTransformerFilter();

        /**
        * Construct a MapEventTransformerFilter based on the specified Filter
        * and MapEventTransformer.
        *
        * @param vFilter      the underlying Filter (e.g. MapEventFilter)
        *                     used to evaluate original MapEvent objects
        *                     (optional)
        * @param vTransformer  the underlying MapEventTransformer used to
        *                     transform original MapEvent objects
        */
        MapEventTransformerFilter(Filter::View vFilter,
                MapEventTransformer::View vTransformer);


    // ----- Filter interface -----------------------------------------------

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


    // ----- MapEventTransformer interface ----------------------------------

    public:
        /**
         * {@inheritDoc}
         */
        virtual MapEvent::Handle transform(MapEvent::Handle hEvent) const;


   // ----- 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 members ---------------------------------------------------

    private:
        /**
        * The underlying Filter  to evaluate MapEvents with.
        */
        MemberView<Filter> m_vFilter;

        /**
        * The underlying transformer
        */
        MemberView<MapEventTransformer> m_vTransformer;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_MAP_EVENT_TRANSFORMER_FILTER_HPP

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