include/anna/dbos/Object.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_dbos_Object_hpp
  10 #define anna_dbos_Object_hpp
  11
  12 #include <anna/core/RuntimeException.hpp>
  13
  14 #include <anna/dbms/DatabaseException.hpp>
  15
  16 #include <anna/dbos/Loader.hpp>
  17
  18 namespace anna {
  19
  20 namespace dbos {
  21
  22 class Creator;
  23
  24 /**
  25    Interfaz que deben cumplir los objetos persistentes.
  26
  27    Ejemplo de definicion de una clase usando esta interfaz:
  28
  29    \include dbos_demo.p/oodb.d/hdrs/dbos_demo.oodb.Table01.h
  30
  31    Ejemplo de implementacion de la clase correspondiente a la definicion:
  32
  33    \include dbos_demo.p/oodb.d/oodb.Table01.cc
  34 */
  35 class Object {
  36 public:
  37   /**
  38      Devuelve el indice asociado a este objeto
  39      \return el indice asociado a este objeto
  40   */
  41   Index getIndex() const throw() { return a_index; }
  42
  43   /**
  44    * Devuelve \em true si este objeto ya existe en el medio físico (fué cargado desde allí o fue creado y grabado posteriormente) o
  45    * \em false si este objeto sólo existe en la memoria intermedia.
  46    * \return \em true si este objeto ya existe en el medio físico (fué cargado desde allí o fue creado y grabado posteriormente) o
  47    * \em false si este objeto sólo existe en la memoria intermedia.
  48    */
  49   bool isStored() const throw() { return a_isStored; }
  50
  51 protected:
  52   /**
  53      Constructor.
  54   */
  55   Object() : a_index(0), a_isStored(false) {;}
  56
  57   /**
  58      Inicializa este objeto con la informacion obtenida desde el medio fisico donde
  59      esta grabado el objeto. Normalmente este medio fisico correspondera con una base de datos.
  60
  61      \param loader Cargador que contiene la informacion con la que debemos inicializar este objeto.
  62
  63   */
  64   virtual void initialize(Loader& loader) throw(RuntimeException, dbms::DatabaseException) = 0;
  65
  66   /**
  67      Actualiza la informacion de este objeto con la nueva informacion obtenida del medio
  68      fisico.
  69      \param creator Creador que contiene la informacion con la que debemos inicializar este objeto.
  70   */
  71   virtual void create(Creator& creator) throw(RuntimeException, dbms::DatabaseException) {;}
  72
  73   /**
  74      Libera los recursos reservados por este objeto. Este metodo solo se invocara cuando el objeto
  75      vaya a ser sacado definitivamente del area de almacenamiento.
  76   */
  77   virtual void destroy() throw() {;}
  78
  79   /**
  80      Devuelve \em true si el registro del medio fisico ha cambiado respecto al registro
  81      cargado en memoria o \em false en otro caso.
  82
  83      \param loader Cargador que contiene la informacion con la que deberiamos re-inicializar
  84      este objeto.
  85
  86      \return \em true si el registro del medio fisico ha cambiado respecto al registro
  87      cargado en memoria o \em false en otro caso.
  88   */
  89   virtual bool hasChanges(Loader& loader) throw(RuntimeException, dbms::DatabaseException) {
  90     return true;
  91   }
  92
  93   /**
  94      Devuelve \em true si el objeto requiere comenzar el proceso de comprobacion de recarga
  95      de datos \em false en otro caso.
  96   */
  97   virtual bool enableUpdate() const throw() { return true; }
  98
  99 private:
 100   Index a_index;
 101   bool a_isStored;
 102
 103   void setIndex(const Index index) throw() { a_index = index; }
 104
 105   friend class StorageArea;
 106 };
 107
 108
 109 }
 110 }
 111
 112 #endif