Oracle Coherence for C++ API
Release 3.7.1.0
E22845-01

coherence/util/CompositeKey.hpp

/*
* CompositeKey.hpp
*
* Copyright (c) 2000, 2011, 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_COMPOSITE_KEY_HPP
#define COH_COMPOSITE_KEY_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/io/pof/PortableObject.hpp"
#include "coherence/net/cache/KeyAssociation.hpp"

#include <ostream>

COH_OPEN_NAMESPACE2(coherence,util)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;
using coherence::io::pof::PortableObject;
using coherence::net::cache::KeyAssociation;


/**
* Key class that consists of a primary and secondary component. Two instances
* of CompositeKey are considered to be equal iff both the primary and
* secondary components of the two instances are considered equal.
* Additionally, the hash code of a CompositeKey takes into the consideration
* the hash codes of its two components. Finally, the CompositeKey class
* implements KeyAssociation by returning the primary component.
*
* @author wl 2010.09.02
*/
class COH_EXPORT CompositeKey
    : public class_spec<CompositeKey,
        extends<Object>,
        implements<KeyAssociation, PortableObject> >
    {
    friend class factory<CompositeKey>;

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

    protected:
        /**
        * Default constructor.
        */
        CompositeKey();

        /**
        * Create a new CompositeKey that consists of the given primary and
        * secondary components.
        *
        * @param voPrimary   the primary key component; must not be null. This
        *                    is also the host key returned by the 
        *                    KeyAssociation implementation
        * @param voSecondary the secondary key component; must not be null
        */
        CompositeKey(Object::View voPrimary, Object::View voSecondary);


    // ----- KeyAssociation interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual Object::View getAssociatedKey() const;


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

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

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


    // ----- Object methods -------------------------------------------------

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

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

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


    // ----- accessors ------------------------------------------------------

    public:
        /**
        * Return the primary key component.
        *
        * @return the primary key component
        */
        virtual Object::View getPrimaryKey() const;

        /**
        * Return the secondary key component.
        *
        * @return the secondary key component
        */
        virtual Object::View getSecondaryKey() const;


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

    private:
        /**
        * The primary key component.
        */
        MemberView<Object> m_voPrimary;

        /**
        * The secondary key component.
        */
        MemberView<Object> m_voSecondary;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_COMPOSITE_KEY_HPP

Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.