C++ Client API Reference for Oracle Coherence: coherence/util/extractor/EntryExtractor.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_ENTRY_EXTRACTOR_HPP
00008 #define COH_ENTRY_EXTRACTOR_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/Map.hpp"
00016 #include "coherence/util/extractor/AbstractExtractor.hpp"
00017 
00018 COH_OPEN_NAMESPACE3(coherence,util,extractor)
00019 
00020 using coherence::io::pof::PofReader;
00021 using coherence::io::pof::PofWriter;
00022 using coherence::util::QueryMap;
00023 
00024 
00025 /**
00026 * The EntryExtractor is a base abstract class for special purpose custom
00027 * ValueExtractor implementations. It allows them to extract a desired value
00028 * using all available information on the corresponding QueryMap.Entry object
00029 * and is intended to be used in advanced custom scenarios, when application
00030 * code needs to look at both key and value at the same time or can make some
00031 * very specific assumptions regarding to the implementation details of the
00032 * underlying Entry object.
00033 *
00034 * @author nsa 2008.08.07
00035 */
00036 class COH_EXPORT EntryExtractor
00037     : public abstract_spec<EntryExtractor,
00038         extends<AbstractExtractor>,
00039         implements<PortableObject> >
00040     {
00041     // ----- constructors ---------------------------------------------------
00042 
00043     protected:
00044         /**
00045         * Default constructor (for backward compatibility).
00046         */
00047         EntryExtractor();
00048 
00049         /**
00050         * Construct an EntryExtractor based on the entry extraction target.
00051         *
00052         * @param nTarget  one of the {@link #value} or {@link #key} values
00053         *
00054         * @since Coherence 3.5
00055         */
00056         EntryExtractor(int32_t nTarget);
00057 
00058 
00059     // ----- PortableObject interface ---------------------------------------
00060 
00061     public:
00062         /**
00063         * {@inheritDoc}
00064         */
00065         virtual void readExternal(PofReader::Handle hIn);
00066 
00067         /**
00068         * {@inheritDoc}
00069         */
00070         virtual void writeExternal(PofWriter::Handle hOut) const;
00071     };
00072 
00073 COH_CLOSE_NAMESPACE3
00074 
00075 #endif // #define COH_ENTRY_EXTRACTOR_HPP