include/anna/dbos/Creator.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_dbos_Creator_hpp
  38 #define anna_dbos_Creator_hpp
  39
  40 #include <anna/dbos/Accesor.hpp>
  41
  42 namespace anna {
  43
  44 namespace dbos {
  45
  46 /**
  47    Interfaz que deben cumplir los objetos encargados de crear un nuevo objeto que sera ubicado
  48    en el area de almacenamiento asociado a un medio fisico.
  49 */
  50 class Creator : public Accesor {
  51 public:
  52   /**
  53      Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos.
  54      Para evitar ambigüedades este nombre deberia incluir la lista completa de \em namespaces
  55      a la que pertenece la clase.
  56      \return Una cadena con el nombre de este selector.
  57   */
  58   virtual const char* getClassName() const throw() { return "anna::dbos::Creator"; }
  59
  60 protected:
  61   /**
  62      Constructor.
  63      \param database Base de datos asociada a este cargador y que deberia servir para
  64      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  65      \param id Identificador de este accesor.
  66   */
  67   Creator(dbms::Database& database, const Id id = 0) : Accesor(database, id) {;}
  68
  69   /**
  70      Constructor.
  71      \param id Identificador de este accesor.
  72   */
  73   Creator(const Id id = 0) : Accesor(id) {;}
  74
  75   /**
  76      Devuelve el indice usado para ubicar en memoria el objeto que vamos a cargar.
  77      @return El indice usado para ubicar en memoria el objeto que vamos a cargar.
  78   */
  79   virtual Index getIndex() const throw(RuntimeException) = 0;
  80
  81 private:
  82   dbms::Statement* initialize(dbms::Database&) throw(RuntimeException) { return NULL;}
  83
  84   friend class StorageArea;
  85 };
  86
  87 }
  88 }
  89
  90 #endif
  91
  92
  93