coherence/util/extractor/ReflectionExtractor.hpp

/*
* ReflectionExtractor.hpp
*
* Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_REFLECTION_EXTRACTOR_HPP
#define COH_REFLECTION_EXTRACTOR_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/util/extractor/AbstractExtractor.hpp"

COH_OPEN_NAMESPACE3(coherence,util,extractor)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;


/**
* Reflection-based ValueExtractor implementation.
*
* ReflectionExtractor cannot be executed against local C++ caches, only
* against remote caches. Locally executable C++ extractors may either be
* custom built, or auto-generated via TypedExtractor<>.
*
* @author djl 2008.03.06
*
* @see ChainedExtractor
* @see TypedExtractor
*/
class COH_EXPORT ReflectionExtractor
    : public cloneable_spec<ReflectionExtractor,
        extends<AbstractExtractor> >
    {
    friend class factory<ReflectionExtractor>;

    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Construct an empty ReflectionExtractor
        * (necessary for the PortableObject interface).
        */
        ReflectionExtractor();

        /**
        * Construct a ReflectionExtractor based on a method name, optional
        * parameters and the entry extraction target.
        *
        * @param vsMethod  the name of the method to invoke via reflection
        * @param vaParam   the array of arguments to be used in the method
        *                  invocation; may be NULL
        * @param nTarget   one of the {@link #VALUE} or {@link #KEY} values
        *
        * @since Coherence 3.5
        */
        ReflectionExtractor(String::View vsMethod,
                ObjectArray::View vaParam = NULL, int32_t nTarget = VALUE);

        /**
        * Copy constructor.
        */
        ReflectionExtractor(const ReflectionExtractor& that);


   // ----- ValueExtractor interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        *
        * @throws UnsupportedOperationException always
        */
        virtual Object::Holder extract(Object::Holder ohTarget) const;


    // ----- PortableObject interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void readExternal(PofReader::Handle hIn);

        /**
        * {@inheritDoc}
        */
        virtual void writeExternal(PofWriter::Handle hOut) const;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;

        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- data member accessors ------------------------------------------

    public:
        /**
        * Determine the name of the method that this extractor is configured
        * to invoke.
        *
        * @return the name of the method to invoke using reflection
        */
        virtual String::View getMethodName() const;

        /**
        * Return the array of arguments used to invoke the method.
        *
        * @return the array of arguments used to invoke the method
        */
        virtual ObjectArray::View getParameters() const;


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * The name of the method to invoke.
        */
        MemberView<String> m_vsMethod;

        /**
        * The parameter array.
        */
        MemberView<ObjectArray> m_vaParam;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_REFLECTION_EXTRACTOR_HPP

Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.