coherence/util/filter/ContainsFilter.hpp

/*
* ContainsFilter.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_CONTAINS_FILTER_HPP
#define COH_CONTAINS_FILTER_HPP

#include "coherence/lang.ns"

#include "coherence/util/ValueExtractor.hpp"
#include "coherence/util/filter/ComparisonFilter.hpp"
#include "coherence/util/filter/IndexAwareFilter.hpp"

COH_OPEN_NAMESPACE3(coherence,util,filter)


/**
* Filter which tests a Collection or Object array value returned from
* a method invocation for containment of a given value.
*
* More formally, if the specified extractor returns a Collection,
* evaluate(o)is functionally equivalent to the following code:
* <pre>
* return ((Collection) extract(o))->contains(getValue());
* </pre>
* If the specified method returns an Object array, evaluate(o) is functionally
* equivalent to the following code:
* <pre>
* return Collections->asList((ObjectArray::View) extract(o))->contains(
*           getValue());
* </pre>
*
* @author djl  2008.04.07
*/
class COH_EXPORT ContainsFilter
    : public class_spec<ContainsFilter,
        extends<ComparisonFilter>,
        implements<IndexAwareFilter> >
    {
    friend class factory<ContainsFilter>;

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

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

        /**
        * Construct an ContainsFilter for testing containment of the given
        * object.
        *
        * @param vExtractor  the ValueExtractor used by this filter
        * @param vValue      the object that a Collection or Object array is
        *                    tested to contain
        */
        ContainsFilter(ValueExtractor::View vExtractor, Object::View vValue);


    // ----- ExtractorFilter interface --------------------------------------

    protected:
        /**
        * Evaluate the specified extracted value.
        *
        * @param vExtracted an extracted value to evaluate
        */
        virtual bool evaluateExtracted(Object::View vExtracted) 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_CONTAINS_FILTER_HPP

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