---

d_Association.h

Go to the documentation of this file.

#ifndef d_Association_h
#define d_Association_h 1

//------------------------------------------------------------------------------
#include "oDynaObject.h"
#include "oStreamable.h"
//------------------------------------------------------------------------------

/**
 * Express an association between a key and a value.
 * 
 * An association is compound of the couple key and value. Key and value can be
 * of any types. 
 * 
 * LOCATION:
 * d_Association.h
 *
 * USAGE:
 * d_Association< <key_type>, <value-type>      <property-name>;
 * 
 * Where:
 * 
 * <key-type >:           Key type. Can be a literal or a user type
 * <value-type >:               Value type. Can be a literal or a user type
 * <PROPERTY-NAME>:     NAME OF PROPERTY
 * 
 * <key-type> must be an ODMG literal or a user type but with the definition of
 *            operator<.
 *
 * EXAMPLES:
 *  * DEFINITION OF A DICTIONARY OF CODE/PRODUCT
 * d_Association< d_String, d_Float >   Rates;
 * 
 * SEE ALSO:
 * d_Dictionary
 *
 * ODMG:
 * Compliant 
 */

template <class K, class V>
class _ODLL d_Association : public oStreamable
{
  public:

    /**
     * Default Constructor.
     *
     * ODMG    :        Compliant 
     */
    d_Association();

    /**
     * Creates and fill a d_Association object.
     *
     * <iDomain> is the domain of the database where the object will be stored.
     *
     * Take the database's domain by d_Database::getDomain().
     *
     * SEE ALSO:        d_Database::getDomain()
     * ODMG    :        Compliant
     */
    d_Association( const K& iKey, const V& iValue, oDomain* iDomain );

    /**
     * Copy Constructor.
     *
     * ODMG    :        Compliant 
     */
    d_Association ( const d_Association<K,V>& iSource );

    /**
     * Destructor.
     *
     * ODMG    :        Compliant 
     */
    ~d_Association();

    // Internal.
    void delete_object(){;}

    // Internal.
    virtual void toStream( oObjectStream& iBuffer,
                           oInterface* iInterface = 0 );
    // Internal.
    virtual void fromStream( oObjectStream& iBuffer,
                             oInterface* iInterface = 0 );

    // Internal.
    K key;
    // Internal.
    V value;

    // Internal.
    oDynaObject keyDynaObject;
    // Internal.
    oDynaObject valueDynaObject;
};

//------------------------------------------------------------------------------
#include "d_Association.cti"

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
#endif

---