coherence/util/filter/AnyFilter.hpp

/*
* AnyFilter.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_ANY_FILTER_HPP
#define COH_ANY_FILTER_HPP

#include "coherence/lang.ns"

#include "coherence/util/Map.hpp"
#include "coherence/util/filter/ArrayFilter.hpp"

COH_OPEN_NAMESPACE3(coherence,util,filter)


/**
* Filter which returns the logical "or" of a filter array.
*
* @author djl  2008.03.23
*/
class COH_EXPORT AnyFilter
    : public class_spec<AnyFilter,
        extends<ArrayFilter> >
    {
    friend class factory<AnyFilter>;

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

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

        /**
        * Construct an "any" filter. The result is defined as:
        *   afilter[0] || afilter[1] ... || afilter[n]
        *
        * @param vaFilter   an array of filters
        */
        AnyFilter(ObjectArray::View vaFilter);


    // ----- 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;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_ANY_FILTER_HPP

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