C++ Client API Reference for Oracle Coherence: coherence/util/processor/ExtractorProcessor.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_EXTRACTOR_PROCESSOR_HPP
00008 #define COH_EXTRACTOR_PROCESSOR_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/InvocableMap.hpp"
00016 #include "coherence/util/ValueExtractor.hpp"
00017 #include "coherence/util/processor/AbstractProcessor.hpp"
00018 
00019 COH_OPEN_NAMESPACE3(coherence,util, processor)
00020 
00021 using coherence::io::pof::PofReader;
00022 using coherence::io::pof::PofWriter;
00023 using coherence::io::pof::PortableObject;
00024 using coherence::util::InvocableMap;
00025 using coherence::util::ValueExtractor;
00026 
00027 
00028 /**
00029 * ExtractorProcessor is an EntryProcessor implementations that extracts a
00030 * value from an object cached in an InvocableMap.
00031 *
00032 * @author tb  2008.04.28
00033 */
00034 class COH_EXPORT ExtractorProcessor
00035     : public class_spec<ExtractorProcessor,
00036         extends<AbstractProcessor>,
00037         implements<PortableObject> >
00038     {
00039     friend class factory<ExtractorProcessor>;
00040 
00041     // ----- constructors ---------------------------------------------------
00042 
00043     protected:
00044         /**
00045         * Construct a ExtractorProcessor.
00046         */
00047         ExtractorProcessor();
00048 
00049         /**
00050         * Construct an ExtractorProcessor based on the specified
00051         * ValueExtractor.
00052         *
00053         * @param vExtractor  a ValueExtractor object; passing null is
00054         *                   equivalent to using the IdentityExtractor
00055         */
00056         ExtractorProcessor(ValueExtractor::View vExtractor);
00057 
00058 
00059     // ----- InvocableMap::EntryProcessor interface -------------------------
00060 
00061     public:
00062         /**
00063         * {@inheritDoc}
00064         */
00065         virtual Object::Holder process(InvocableMap::Entry::Handle hEntry) const;
00066 
00067 
00068     // ----- PortableObject interface ---------------------------------------
00069 
00070     public:
00071         /**
00072         * {@inheritDoc}
00073         */
00074         virtual void readExternal(PofReader::Handle hIn);
00075 
00076         /**
00077         * {@inheritDoc}
00078         */
00079         virtual void writeExternal(PofWriter::Handle hOut) const;
00080 
00081 
00082     // ----- Object interface -----------------------------------------------
00083 
00084     public:
00085         /**
00086         * {@inheritDoc}
00087         */
00088         virtual bool equals(Object::View v) const;
00089 
00090         /**
00091         * {@inheritDoc}
00092         */
00093         virtual size32_t hashCode() const;
00094 
00095 
00096     // ----- data members ---------------------------------------------------
00097 
00098     protected:
00099         /**
00100         * The underlying value extractor.
00101         */
00102         FinalView<ValueExtractor> f_vExtractor;
00103     };
00104 
00105 COH_CLOSE_NAMESPACE3
00106 
00107 #endif // COH_EXTRACTOR_PROCESSOR_HPP