Oracle Coherence for C++ API
Release 3.6.0.0

E15728-01

coherence/util/filter/PriorityFilter.hpp

00001 /*
00002 * PriorityFilter.hpp
00003 *
00004 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
00005 *
00006 * Oracle is a registered trademarks of Oracle Corporation and/or its
00007 * affiliates.
00008 *
00009 * This software is the confidential and proprietary information of Oracle
00010 * Corporation. You shall not disclose such confidential and proprietary
00011 * information and shall use it only in accordance with the terms of the
00012 * license agreement you entered into with Oracle.
00013 *
00014 * This notice may not be removed or altered.
00015 */
00016 #ifndef COH_PRIORITY_FILTER_HPP
00017 #define COH_PRIORITY_FILTER_HPP
00018 
00019 #include "coherence/lang.ns"
00020 
00021 #include "coherence/io/pof/PofReader.hpp"
00022 #include "coherence/io/pof/PofWriter.hpp"
00023 #include "coherence/net/AbstractPriorityTask.hpp"
00024 #include "coherence/util/filter/EntryFilter.hpp"
00025 #include "coherence/util/filter/IndexAwareFilter.hpp"
00026 
00027 COH_OPEN_NAMESPACE3(coherence,util,filter)
00028 
00029 using coherence::io::pof::PofReader;
00030 using coherence::io::pof::PofWriter;
00031 using coherence::net::AbstractPriorityTask;
00032 
00033 
00034 /**
00035 * Base Filter implementation for doing extractor-based processing.
00036 *
00037 * @author djl  2008.03.02
00038 */
00039 class COH_EXPORT PriorityFilter
00040     : public class_spec<PriorityFilter,
00041         extends<AbstractPriorityTask>,
00042         implements<IndexAwareFilter> >
00043     {
00044     friend class factory<PriorityFilter>;
00045 
00046     // ----- constructors ---------------------------------------------------
00047 
00048     protected:
00049         /**
00050         * Default constructor (necessary for the PortableObject interface).
00051         */
00052         PriorityFilter();
00053 
00054         /**
00055         * Construct a PriorityFilter.
00056         *
00057         * @param vFilter  the filter wrapped by this PriorityFilter
00058         */
00059         PriorityFilter(IndexAwareFilter::View vFilter);
00060 
00061 
00062     // ----- EntryFilter interface ------------------------------------------
00063 
00064     public:
00065         /**
00066         * {@inheritDoc}
00067         */
00068         virtual bool evaluateEntry(Map::Entry::View vEntry) const;
00069 
00070 
00071     // ----- Filter interface -----------------------------------------------
00072 
00073     public:
00074         /**
00075         * {@inheritDoc}
00076         */
00077         virtual bool evaluate(Object::View v) const;
00078 
00079 
00080     // ----- IndexAwareFilter interface -------------------------------------
00081 
00082     public:
00083         /**
00084         * {@inheritDoc}
00085         */
00086         virtual size32_t calculateEffectiveness(Map::View vMapIndexes,
00087                 Set::View vSetKeys) const;
00088 
00089         /**
00090         * {@inheritDoc}
00091         */
00092         virtual Filter::View applyIndex(Map::View vMapIndexes,
00093                 Set::Handle hSetKeys) const;
00094 
00095 
00096     // ----- PortableObject interface ---------------------------------------
00097 
00098      public:
00099         /**
00100         * {@inheritDoc}
00101         */
00102         virtual void readExternal(PofReader::Handle hIn);
00103 
00104         /**
00105         * {@inheritDoc}
00106         */
00107         virtual void writeExternal(PofWriter::Handle hOut) const;
00108 
00109 
00110     // ----- Object interface -----------------------------------------------
00111 
00112     public:
00113         /**
00114         * {@inheritDoc}
00115         */
00116         virtual void toStream(std::ostream& out) const;
00117 
00118 
00119     // ----- data member accessors ------------------------------------------
00120 
00121     public:
00122         /**
00123         * Obtain the underlying filter.
00124         *
00125         * @return the filter wrapped by this PriorityFilter
00126         */
00127         virtual IndexAwareFilter::View getFilter() const;
00128 
00129 
00130     // ----- data members ---------------------------------------------------
00131 
00132     protected:
00133         /**
00134         * The wrapped filter.
00135         */
00136         MemberView<IndexAwareFilter> m_vFilter;
00137     };
00138 
00139 COH_CLOSE_NAMESPACE3
00140 
00141 #endif //COH_PRIORITY_FILTER_HPP
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.