coherence/util/filter/ArrayFilter.hpp

/*
* ArrayFilter.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_ARRAY_FILTER_HPP
#define COH_ARRAY_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/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::io::pof::PortableObject;


/**
* Filter which is a logical operator of a filter array.
*
* @author djl  2008.03.23
*/
class COH_EXPORT ArrayFilter
    : public abstract_spec<ArrayFilter,
        extends<Object>,
        implements<IndexAwareFilter, PortableObject> >
    {
    // ----- constructors ---------------------------------------------------

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

        /**
        * Construct a logical filter that applies a binary operator to a
        * filter array. The result is defined as:
        *   aFilter[0] &lt;op&gt; aFilter[1] ... &lt;op&gt; aFilter[n]
        *
        * @param vaFilter  the filter array
        */
        ArrayFilter(ObjectArray::View vaFilter);


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

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

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


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

    public:
        /**
        * Compare the ArrayFilter with another object to determine
        * equality. Two ArrayFilter objects are considered equal
        * iff they belong to the same class and their underlying Filter
        * arrays are deep-equal.
        *
        * @return true iff this ArrayFilter and the passed object
        *         are equivalent
        */
        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:
        /**
        * Obtain the Filter array.
        *
        * @return the Filter array
        */
        virtual ObjectArray::View getFilters() const;


    // ----- internal helpers -----------------------------------------------

    protected:
        /**
        * Calculate the effectiveness and sort all the participating filters
        * according to their effectiveness.
        *
        * @param vMapIndexes  the available MapIndex objects keyed by
        *                     the related ValueExtractor; read-only
        * @param vSetKeys     the set of keys that will be filtered; read-only
        *
        * @return the array of WeightedFilter objects sorted by the
        *         effectiveness (the most effective in the front)
        */
        virtual ObjectArray::View calculateFilters(Map::View vMapIndexes,
                Set::View vSetKeys) const;


        /**
        * Apply the specified IndexAwareFilter to the specified keySet.
        *
        * @param vFilter      the IndexAwareFilter to apply an index to
        * @param vMapIndexes  the available MapIndex objects keyed by
        *                     the related ValueExtractor; read-only
        * @param hSetKeys     the mutable set of keys that remain to be
        *                     filtered
        *
        * @return a Filter object that can be used to process the remaining
        *         keys, or null if no additional filter processing is
        *         necessary
        */
        virtual Filter::View applyFilter(IndexAwareFilter::View vFilter,
                Map::View vMapIndexes, Set::Handle hSetKeys) const;


    // ----- inner class: WeightedFilter ------------------------------------

    public:
        /**
        * A thin wrapper around a Filter allowing for sorting the filters
        * according to their effectiveness.
        *
        * @author tb  2009.02.09
        */
        class COH_EXPORT WeightedFilter
            : public class_spec<WeightedFilter,
                    extends<Object>,
                    implements<Comparable> >
            {
            friend class factory<WeightedFilter>;

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

            protected:
                /**
                * Construct the WeightedFilter.
                *
                * @param vFilter  the wrapped filter
                * @param nEffect  the filter's effectiveness
                */
                WeightedFilter(Filter::View vFilter, int32_t nEffect);

            // ----- Comparable interface -------------------------------

            public:
                /**
                * Compares this WeightedFilter with the specified
                * WeightedFilter for order.  Returns a negative integer, zero,
                * or a positive integer as this WeightedFilter's effectiveness
                * is less than, equal to, or greater than the effectiveness of
                * the specified WeightedFilter object.
                *
                * @param v  the Object to be compared
                *
                * @return a negative integer, zero, or a positive integer as
                *         this object is less than, equal to, or greater than
                *         the specified object
                *
                * @throws ClassCastException if the specified object's type
                *         prevents it from being compared to this
                *         WeightedFilter
                */
                int32_t compareTo(Object::View v) const;

            // ----- accessors ------------------------------------------

            public:
                /**
                * Get the wrapped filter.
                *
                * @return the wrapped filter
                */
                Filter::View getFilter() const;

                /**
                * Get the effectiveness value of the wrapped filter.
                *
                * @return the effectiveness of the wrapped filter
                */
                int32_t getEffectiveness() const;

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

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

                /**
                * The effectiveness of the wrapped filter.
                */
                int32_t m_nEffect;
            };


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

    protected:
        /**
        * The Filter array.
        */
        MemberView<ObjectArray> m_vaFilter;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_EXTRACTOR_FILTER_HPP

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