---

CdbBdbObjectCloneImpl.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_CLONE_IMPL_HH
#define CDBBDB_OBJECT_CLONE_IMPL_HH

// File and Version Information:
//      $Id: CdbBdbObjectCloneImpl.hh,v 1.2 2004/10/21 20:35:49 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include <string>

#include <oo.h>         // Objectivity/DB core API
#include <ooas.h>       // Objectivity/DB Active Schema API

// Forward declarations

class CdbBdbObjectCloneUserAction;

template< class T > class CdbBdbCache;

/// This class implements the "deep clone" facility for persistent objects.
/**
  * More details...
  */
class CdbBdbObjectCloneImpl {

    friend class CdbBdbObjectClone;     // who is able to create and destroy me

private:

  /// Default constructor (NOT IMPLEMENTED)
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::CdbBdbObjectClone()
    */
    CdbBdbObjectCloneImpl( );

  /// Normal constructor
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::CdbBdbObjectClone()
    */
    CdbBdbObjectCloneImpl(          const ooRef(ooObj)& theHint,
                           CdbBdbObjectCloneUserAction* theUserAction,
                                                   bool deepCopyMode,
                                                   bool verboseMode,
                                                   bool debugMode );

  /// Destructor
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::~CdbBdbObjectClone()
    */
    virtual ~CdbBdbObjectCloneImpl( );

  /// Make a persistent clone of the specified object
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::clone()
    */
    virtual bool clone( const ooHandle(ooObj)& theInputH,
                              ooHandle(ooObj)& theOutputH );
  /// Set hint
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::setHint()
    */
    ooRef(ooObj) setHint( const ooRef(ooObj)& theHint );

  /// Set user action
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectClone::setUserAction()
    */
    CdbBdbObjectCloneUserAction* setUserAction( CdbBdbObjectCloneUserAction* theUserAction );

private:

    /// An automatic prefix class
    /**
      * This internal helper class is meant to help with forming a proper prefix
      * string depending on the current "level" in a copied graph.
      */
    class Prefix {

    private:

      /// Default constructor (NOT IMPLEMENTED)
      /**
        * The object's default does not make any sense at all.
        */
        Prefix( );

      /// Copy constructor (NOT IMPLEMENTED)
      /**
        * Copying of these objects does not make any sense at all.
        */
        Prefix( const Prefix& );

      /// Assignment operator (NOT IMPLEMENTED)
      /**
        * Copying of these objects does not make any sense at all.
        */
        Prefix& operator=( const Prefix& );

    public:

      /// Normal constructor
      /**
        * Decrement the current level at the caller's context.
        * Set up the current prefix string at the current context.
        */
        Prefix(               int& theLevel,        /**< a reference onto the caller's context */
                const std::string& theStep = "  "   /**< the step between levels */
              );

      /// Destructor
      /**
        * Decrement the current level at the caller's context.
        */
        ~Prefix( );

      /// An explicit type conversion operator
      /**
        * Will return a pointer onto the current prefix string.
        *
        * NONE: The returned string is bound to the local object's context.
        */
        const char* c_str( ) const;

    private:

               int& _level;   // a reference onto the caller's context
        std::string _str;     // the current prefix
    };

  // Helper methods

    bool cloneObject( const ooHandle(ooObj)& theH,
                            ooHandle(ooObj)& theOutputH );

    void copyObjectContents( const ooas::Class_Object& theClassObject,
                                   ooas::Class_Object& theOutputClassObject,
                                         const Prefix& thePrefix );

    void copyStringValue( const ooas::String_Value& theStringValue,
                                ooas::String_Value& theOutputStringValue,
                                      const Prefix& thePrefix );

    void copyVArrayObject( const ooas::VArray_Object& theVArrayObject,
                                 ooas::VArray_Object& theOutputVArrayObject,
                                  const ooas::d_Type& theVArrayTypeDsc,
                                        const Prefix& thePrefix );

private:

  // Current context

    bool _deepCopyMode;
    bool  _verboseMode;
    bool    _debugMode;

    CdbBdbObjectCloneUserAction* _userAction;

    ooHandle(ooObj)    _hintH;  // a location of the output objects  (set up by the c-tor)
    ooHandle(ooObj)    _rootH;  // an object a cloning begins        (set up by the cloning method)
    ooHandle(ooObj) _currentH;  // a current object being copied     (is "root" at the beginning, then changes)

  // A dictionary to map OID-s of input (to be copied) objects into their output
  // copies. The dictionary is used for the following reasons:
  //
  // - to optimize copy for objects which have already been copied
  // - to prevent duplicating the same source object at a destination
  // - to escape from the cyclic graph problem

    CdbBdbCache< ooRef(ooObj) >* _dictionary;

  // Supplementary data structures

    int _level;     // the current level in a copied graph (begins with 0 for 'root' object)
};

#endif  // CDBBDB_OBJECT_CLONE_IMPL_HH

---