C++ Client API Reference for Oracle Coherence: coherence/util/transformer/SemiLiteEventTransformer.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_SEMI_LITE_EVENT_TRANSFORMER_HPP
00008 #define COH_SEMI_LITE_EVENT_TRANSFORMER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PofReader.hpp"
00013 #include "coherence/io/pof/PofWriter.hpp"
00014 #include "coherence/io/pof/PortableObject.hpp"
00015 #include "coherence/util/MapEvent.hpp"
00016 #include "coherence/util/MapEventTransformer.hpp"
00017 
00018 COH_OPEN_NAMESPACE3(coherence,util,transformer)
00019 
00020 using coherence::io::pof::PofReader;
00021 using coherence::io::pof::PofWriter;
00022 using coherence::io::pof::PortableObject;
00023 
00024 
00025 /**
00026 * SemiLiteEventTransformer is a special purpose MapEventTransformer
00027 * implementation that removes an OldValue from the MapEvent object for the
00028 * purpose of reducing the amount of data that has to be sent over the network
00029 * to event consumers.
00030 *
00031 * Usage example:
00032 * <pre>
00033 *    cache->addMapListener(listener, MapEventTransformerFilter::create(NULL,
00034 *        SemiLiteEventTransformer::getInstance(), false);
00035 * </pre>
00036 *
00037 * @author djl  2008.06.17
00038 */
00039 class COH_EXPORT SemiLiteEventTransformer
00040     : public class_spec<SemiLiteEventTransformer,
00041         extends<Object>,
00042         implements<PortableObject, MapEventTransformer> >
00043     {
00044     friend class factory<SemiLiteEventTransformer>;
00045 
00046     // ----- constructors ---------------------------------------------------
00047 
00048     protected:
00049         /**
00050         * Default constructor (necessary for the PortableObject interface).
00051         */
00052         SemiLiteEventTransformer();
00053 
00054 
00055     // ----- MapEventTransformer interface ----------------------------------
00056 
00057     public:
00058         /**
00059          * {@inheritDoc}
00060          */
00061         virtual MapEvent::Handle transform(MapEvent::Handle hEvent) const;
00062 
00063 
00064     // ----- PortableObject interface ---------------------------------------
00065 
00066     public:
00067         /**
00068         * {@inheritDoc}
00069         */
00070         virtual void readExternal(PofReader::Handle hIn);
00071 
00072         /**
00073         * {@inheritDoc}
00074         */
00075         virtual void writeExternal(PofWriter::Handle hOut) const;
00076 
00077 
00078     // ----- Object interface -----------------------------------------------
00079 
00080     public:
00081         /**
00082         * {@inheritDoc}
00083         */
00084         virtual bool equals(Object::View v) const;
00085 
00086         /**
00087         * {@inheritDoc}
00088         */
00089         virtual size32_t hashCode() const;
00090 
00091         /**
00092         * {@inheritDoc}
00093         */
00094         virtual TypedHandle<const String> toString() const;
00095 
00096 
00097     // ----- constants ------------------------------------------------------
00098 
00099     public:
00100         /**
00101         * The SemiLiteEventTransformer singleton.
00102         */
00103         static SemiLiteEventTransformer::Handle getInstance();
00104     };
00105 
00106 COH_CLOSE_NAMESPACE3
00107 
00108 #endif // COH_SEMI_LITE_EVENT_TRANSFORMER_HPP