Oracle Coherence for C++ API
Release 3.6.0.0

E15728-01

coherence/util/processor/ConditionalPutAll.hpp

00001 /*
00002 * ConditionalPutAll.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_CONDITIONAL_PUT_ALL_HPP
00017 #define COH_CONDITIONAL_PUT_ALL_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/Filter.hpp"
00025 #include "coherence/util/InvocableMap.hpp"
00026 #include "coherence/util/Map.hpp"
00027 #include "coherence/util/processor/AbstractProcessor.hpp"
00028 
00029 COH_OPEN_NAMESPACE3(coherence,util, processor)
00030 
00031 using coherence::io::pof::PofReader;
00032 using coherence::io::pof::PofWriter;
00033 using coherence::io::pof::PortableObject;
00034 using coherence::util::Filter;
00035 using coherence::util::InvocableMap;
00036 using coherence::util::Map;
00037 
00038 
00039 /**
00040 * ConditionalPutAll is an EntryProcessor that performs a
00041 * InvocableMap::Entry#setValue Entry.setValue} operation for multiple entries
00042 * that satisfy the specified condition.
00043 *
00044 * @author tb  2008.04.28
00045 */
00046 class COH_EXPORT ConditionalPutAll
00047     : public class_spec<ConditionalPutAll,
00048         extends<AbstractProcessor>,
00049         implements<PortableObject> >
00050     {
00051     friend class factory<ConditionalPutAll>;
00052 
00053     // ----- constructors ---------------------------------------------------
00054 
00055     protected:
00056         /**
00057         * Construct a ConditionalPutAll.
00058         */
00059         ConditionalPutAll();
00060 
00061         /**
00062         * Construct a ConditionalPutAll processor that updates an entry with
00063         * a new value if and only if the filter applied to the entry
00064         * evaluates to true. The new value is extracted from the specified
00065         * map based on the entry's key.
00066         *
00067         * @param vFilter  the filter to evaluate all supplied entries
00068         * @param vMap     a map of values to update entries with
00069         */
00070         ConditionalPutAll(Filter::View vFilter, Map::View vMap);
00071 
00072 
00073     // ----- InvocableMap::EntryProcessor interface -------------------------
00074 
00075     public:
00076         /**
00077         * {@inheritDoc}
00078         */
00079         virtual Object::Holder process(
00080                 InvocableMap::Entry::Handle hEntry) const;
00081 
00082         /**
00083         * {@inheritDoc}
00084         */
00085         virtual Map::View processAll(Set::View vsetEntries) const;
00086 
00087 
00088     // ----- PortableObject interface ---------------------------------------
00089 
00090     public:
00091         /**
00092         * {@inheritDoc}
00093         */
00094         virtual void readExternal(PofReader::Handle hIn);
00095 
00096         /**
00097         * {@inheritDoc}
00098         */
00099         virtual void writeExternal(PofWriter::Handle hOut) const;
00100 
00101 
00102     // ----- Object interface -----------------------------------------------
00103 
00104     public:
00105         /**
00106         * {@inheritDoc}
00107         */
00108         virtual bool equals(Object::View v) const;
00109 
00110         /**
00111         * {@inheritDoc}
00112         */
00113         virtual size32_t hashCode() const;
00114 
00115 
00116     // ----- data members ---------------------------------------------------
00117 
00118     protected:
00119         /**
00120         * The underlying filter.
00121         */
00122         MemberView<Filter> m_vFilter;
00123 
00124         /**
00125         * Specifies the map of new values.
00126         */
00127         MemberView<Map> m_vMap;
00128     };
00129 
00130 COH_CLOSE_NAMESPACE3
00131 
00132 #endif // COH_CONDITIONAL_PUT_ALL_HPP
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.