Oracle Coherence for C++ API
Release 3.7.0.0

E18684-01

coherence/util/filter/PresentFilter.hpp

00001 /*
00002 * PresentFilter.hpp
00003 *
00004 * Copyright (c) 2000, 2011, 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_PRESENT_FILTER_HPP
00017 #define COH_PRESENT_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/io/pof/PortableObject.hpp"
00024 #include "coherence/util/Map.hpp"
00025 #include "coherence/util/filter/EntryFilter.hpp"
00026 #include "coherence/util/filter/IndexAwareFilter.hpp"
00027 
00028 COH_OPEN_NAMESPACE3(coherence,util,filter)
00029 
00030 using coherence::io::pof::PofReader;
00031 using coherence::io::pof::PofWriter;
00032 using coherence::io::pof::PortableObject;
00033 
00034 
00035 /**
00036 * Filter which returns true for InvocableMap::Entry objects that currently
00037 * exist in a Map.
00038 *
00039 * This Filter is intended to be used solely in combination with a
00040 * ConditionalProcessor and is unnecessary for standard QueryMap operations.
00041 *
00042 * @author djl  2008.04.08
00043 *
00044 * @see InvocableMap::Entry#isPresent()
00045 */
00046 class COH_EXPORT PresentFilter
00047     : public class_spec<PresentFilter,
00048         extends<Object>,
00049         implements<IndexAwareFilter, PortableObject> >
00050     {
00051     friend class factory<PresentFilter>;
00052 
00053     // ----- constructors ---------------------------------------------------
00054 
00055     protected:
00056         /**
00057         * Construct a PresentFilter.
00058         */
00059         PresentFilter();
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 bool equals(Object::View v) const;
00117 
00118         /**
00119         * {@inheritDoc}
00120         */
00121         virtual size32_t hashCode() const;
00122 
00123         /**
00124         * {@inheritDoc}
00125         */
00126         virtual void toStream(std::ostream& out) const;
00127 
00128 
00129     // ----- constants ------------------------------------------------------
00130 
00131     public:
00132         /**
00133         * An instance of the PresentFilter.
00134         */
00135         static PresentFilter::Handle getInstance();
00136     };
00137 
00138 COH_CLOSE_NAMESPACE3
00139 
00140 #endif // COH_PRESENT_FILTER_HPP
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.