---

CdbTranslatorsDictBase.hh

Go to the documentation of this file.

#ifndef CDB_TRANSLATORS_DICT_BASE_HH
#define CDB_TRANSLATORS_DICT_BASE_HH

// File and Version Information:
//      $Id: CdbTranslatorsDictBase.hh,v 1.1 2005/05/03 20:59:51 gapon Exp $

#include "CdbBase/CdbCPtr.hh"

#include <string>

class CdbObjectTranslator;

/// A base interface for a dictionary fo user defined translators
/**
  * The dictionary manages user defined translators for "persistent-to-transient"
  * transformation.
  *
  * Notes on the dictionary use:
  *
  * 1. It's expected that there is a unique one-to-one correspondance between
  *    persistent and transient classes. This policy will be enforced by
  *    the "add()" method of the dictionary.
  *
  * 2. Translators are indexed by mean of two keys:
  *
  *      a transient class's identifier (produced using the CdbType2Id class)
  *      a persistent class's name
  *
  * @see class CdbType2Id
  * @see class CdbObjectTranslator
  */
class CdbTranslatorsDictBase {

public:

  /// The destructor

    virtual ~CdbTranslatorsDictBase( ) { }

  /// Add a translator
  /**
    * @see class CdbObjectTranslator
    */
    virtual CdbStatus add( const CdbCPtr< CdbObjectTranslator>& theTranslatorPtr ) = 0;

  /// Find a translator by the specified keys
  /**
    * The method will return a pointer on the translator or 0 if no object matching
    * the specified name is found.
    *
    * @see class CdbObjectTranslator
    */
    virtual CdbCPtr< CdbObjectTranslator > find( unsigned int       theTranseintTypeId,
                                                 const std::string& thePersistentTypeName
                                               ) const = 0;
};

#endif  // CDB_TRANSLATORS_DICT_BASE_HH

---