Oracle Fusion Middleware C++ API Reference for Oracle Coherence: coherence/util/filter/LessFilter.hpp Source File

00001 /*
00002 * LessFilter.hpp
00003 *
00004 * Copyright (c) 2000, 2013, 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_LESS_FILTER_HPP
00017 #define COH_LESS_FILTER_HPP
00018 
00019 #include "coherence/lang.ns"
00020 
00021 #include "coherence/util/ValueExtractor.hpp"
00022 #include "coherence/util/filter/ComparisonFilter.hpp"
00023 #include "coherence/util/filter/IndexAwareFilter.hpp"
00024 
00025 COH_OPEN_NAMESPACE3(coherence,util,filter)
00026 
00027 
00028 /**
00029 * Filter which compares the result of a method invocation with a value for
00030 * "Less" condition. In a case when either result of a method
00031 * invocation or a value to compare are equal to NULL, the <tt>evaluate</tt>
00032 * test yields <tt>false</tt>. This approach is equivalent to the way
00033 * the NULL values are handled by SQL.
00034 *
00035 * @author djl  2008.03.06
00036 */
00037 class COH_EXPORT LessFilter
00038     : public class_spec<LessFilter,
00039         extends<ComparisonFilter>,
00040         implements<IndexAwareFilter> >
00041     {
00042     friend class factory<LessFilter>;
00043 
00044     // ----- constructors ---------------------------------------------------
00045 
00046     protected:
00047         /**
00048         * Default constructor (necessary for the PortableObject interface).
00049         */
00050         LessFilter();
00051 
00052         /**
00053         * Construct a LessFilter for testing "Less" condition.
00054         *
00055         * @param vValueExtractor  the ValueExtractor to use by this filter
00056         * @param vComparable      the object to compare the result with
00057         */
00058         LessFilter(ValueExtractor::View vValueExtractor,
00059                 Comparable::View vComparable);
00060 
00061     private:
00062         /**
00063         * Blocked copy constructor.
00064         */
00065         LessFilter(const LessFilter&);
00066 
00067 
00068     // ----- ExtractorFilter interface --------------------------------------
00069 
00070     protected:
00071         /**
00072         * {@inheritDoc}
00073         */
00074         virtual bool evaluateExtracted(Object::View vExtracted) const;
00075 
00076 
00077     // ----- IndexAwareFilter interface -------------------------------------
00078 
00079     public:
00080         /**
00081         * {@inheritDoc}
00082         */
00083         virtual size32_t calculateEffectiveness(Map::View vMapIndexes,
00084                 Set::View vSetKeys) const;
00085 
00086         /**
00087         * {@inheritDoc}
00088         */
00089         virtual Filter::View applyIndex(Map::View vMapIndexes,
00090                 Set::Handle hSetKeys) const;
00091     };
00092 
00093 COH_CLOSE_NAMESPACE3
00094 
00095 #endif // COH_LESS_FILTER_HPP