coherence/util/filter/PriorityFilter.hpp

/*
* PriorityFilter.hpp
*
* Copyright (c) 2000, 2009, 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_PRIORITY_FILTER_HPP
#define COH_PRIORITY_FILTER_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/net/AbstractPriorityTask.hpp"
#include "coherence/util/filter/EntryFilter.hpp"
#include "coherence/util/filter/IndexAwareFilter.hpp"

COH_OPEN_NAMESPACE3(coherence,util,filter)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;
using coherence::net::AbstractPriorityTask;


/**
* Base Filter implementation for doing extractor-based processing.
*
* @author djl  2008.03.02
*/
class COH_EXPORT PriorityFilter
    : public class_spec<PriorityFilter,
        extends<AbstractPriorityTask>,
        implements<IndexAwareFilter> >
    {
    friend class factory<PriorityFilter>;

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

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

        /**
        * Construct a PriorityFilter.
        *
        * @param vFilter  the filter wrapped by this PriorityFilter
        */
        PriorityFilter(IndexAwareFilter::View vFilter);


    // ----- EntryFilter interface ------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool evaluateEntry(Map::Entry::View vEntry) const;


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

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


    // ----- IndexAwareFilter interface -------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual size32_t calculateEffectiveness(Map::View vMapIndexes,
                Set::View vSetKeys) const;

        /**
        * {@inheritDoc}
        */
        virtual Filter::View applyIndex(Map::View vMapIndexes,
                Set::Handle hSetKeys) const;


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

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

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


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

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


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

    public:
        /**
        * Obtain the underlying filter.
        *
        * @return the filter wrapped by this PriorityFilter
        */
        virtual IndexAwareFilter::View getFilter() const;


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

    protected:
        /**
        * The wrapped filter.
        */
        MemberView<IndexAwareFilter> m_vFilter;
    };

COH_CLOSE_NAMESPACE3

#endif //COH_PRIORITY_FILTER_HPP

Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.