---

CdbBdbObjectTranslatorPT.hh

Go to the documentation of this file.

#ifndef CDB_BDB_OBJECT_TRANSLATOR_PT_HH
#define CDB_BDB_OBJECT_TRANSLATOR_PT_HH

// File and Version Information:
//      $Id: CdbBdbObjectTranslatorPT.hh,v 1.1 2005/05/03 21:15:14 gapon Exp $

#include "BdbUtil/Bdb.hh"

#include "CdbBase/CdbObjectTranslatorT.hh"

#include <string>

/// The transient & persistent type specific specialization of persistent-to-transient translators
/**
  * This class is an element of the "persistent-to-transient" translation facility
  * extending the core CDB API and allowing a better (and more confined) controll
  * over persistency in client applications.
  *
  * Roles of this class are:
  *
  *   1. to translate an actual persistent type into its name
  *   2. to be a direct base class for concrete persistent-technology translators
  *
  * @see class CdbObjectTranslatorT
  */
template< class P,
          class T >
class CdbBdbObjectTranslatorPT : public CdbObjectTranslatorT<T> {

private:

  /// Obtain a name of the current persistent type
  /**
    * IMPLEMENTATION NOTES:
    *
    *   1. This operation will crash if it will faild to get the type information!
    *
    *   2. The operation may start a short transaction of none is available yet.
    *      The transaction is needed to translate the specified persistent type into
    *      its name.
    */
    static std::string persistentType2Name( );

private:

  /// Copy constructor (NOT IMPLEMENTED)

    CdbBdbObjectTranslatorPT( const CdbBdbObjectTranslatorPT<P,T>& );

  /// Assignment operator (NOT IMPLEMENTED)

    CdbBdbObjectTranslatorPT<P,T>& operator=( const CdbBdbObjectTranslatorPT<P,T>& );

protected:

  /// Default constructor
  /**
    * IMPLEMENTATION NOTES:
    *
    *   The constructor may start a short transaction of none is available yet.
    *   The transaction is needed to translate the specified persistent type into
    *   its name.
    */
    CdbBdbObjectTranslatorPT(  );

private:

  /// Translate into a transient object (transient type specific translation)
  /**
    * This method is implemented in terms of the redefined persistent type specific,
    * version which itself will have to be implemented by subclasses.
    *
    * DESIGN NOTE:
    *
    *   Note, that this method has moved into the "private" area to prevent
    *   it from being see by subclasses. Is this going to work w/o causing
    *   any compiler complains?
    *
    * @see CdbObjectTranslatorT::toTransientT()
    */
    virtual CdbStatus toTransientT( T*& theTransientPtr, /**< the pointer to be initialized with the result */
                                    const CdbObjectPtr& theObjectPtr     /**< the input metadata object */
                                  ) const;
protected:

  /// Translate into a transient object (persistent & transient type specific translation)
  /**
    * This is a redefined version of a similar method CdbObjectTranslatorT::toTransientT()
    * defined in the base class and implemented above. Its role is to force translation
    * procedures of subclasses be written in terms of the specified persistent & transinet types.
    *
    * The method is supposed to be implemented by subclasses. The method is guaranteed
    * to be called with the correct parameters.
    *
    * @see CdbObjectTranslatorT::toTransientT()
    */
    virtual CdbStatus toTransientPT( T*&                 theTransientPtr,   /**< the pointer to be initialized with the result */
                                     const BdbHandle(P)& theObjectH         /**< the input persistent object */
                                   ) const = 0;
public:

  /// Destructor

    virtual ~CdbBdbObjectTranslatorPT( ) { }
};

#ifdef    BABAR_COMP_INST
#include "CdbBdb/CdbBdbObjectTranslatorPT.cc"
#endif /* BABAR_COMP_INST */

#endif  // CDB_BDB_OBJECT_TRANSLATOR_PT_HH

---