Oracle Coherence for C++ API
Release 3.6.0.0
E15728-01

coherence/util/filter/ExtractorFilter.hpp

/*
* ExtractorFilter.hpp
*
* Copyright (c) 2000, 2010, 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_EXTRACTOR_FILTER_HPP
#define COH_EXTRACTOR_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/Map.hpp"
#include "coherence/util/ValueExtractor.hpp"
#include "coherence/util/filter/EntryFilter.hpp"

COH_OPEN_NAMESPACE3(coherence,util,filter)

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


/**
* Base Filter implementation for doing extractor-based processing.
*
* @author djl  2008.03.02
*/
class COH_EXPORT ExtractorFilter
    : public abstract_spec<ExtractorFilter,
        extends<Object>,
        implements<EntryFilter, PortableObject> >
    {
    // ----- constructors ---------------------------------------------------

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

        /**
        * Construct a ExtractorFilter for a given ValueExtractor.
        *
        * @param vExtractor the ValueExtractor to use by this filter
        */
        ExtractorFilter(ValueExtractor::View vExtractor);


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

    protected:
        /**
        * Evaluate the specified extracted value.
        *
        * @param vExtracted  an extracted value to evaluate
        */
        virtual bool evaluateExtracted(Object::View vExtracted) const = 0;

        /**
        * Get the result of ValueExtractor invocation.
        *
        * @param v  the object on which to invoke the ValueExtractor;
        *           must not be null
        *
        * @return the result of the method invocation
        */
        virtual Object::View extract(Object::View v) const;


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

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


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

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool evaluate(Object::View v) 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 ValueExtractor used by this filter.
        *
        * @return the ValueExtractor::View used by this filter
        */
        virtual ValueExtractor::View getValueExtractor() const;


    // ----- constants ------------------------------------------------------

    public:
        /**
        * The evaluation cost as a factor to the single index access operation.
        *
        * @see IndexAwareFilter#calculateEffectiveness(Map, Set)
        */
        static const size32_t EVAL_COST = 1000;


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

    protected:
        /**
        * The ValueExtractor used by this filter.
        */
        MemberView<ValueExtractor> m_vExtractor;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_EXTRACTOR_FILTER_HPP

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