include/anna/dbos/Loader.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_Loader_hpp
  38 #define anna_dbos_Loader_hpp
  39
  40 #include <anna/dbos/Accesor.hpp>
  41
  42 namespace anna {
  43
  44 namespace dbms {
  45 class Database;
  46 }
  47
  48 namespace dbos {
  49
  50 class CrossedLoader;
  51
  52 /**
  53    Interfaz que deben cumplir los objetos encargados de cargar el objeto desde el medio fisico,
  54    que normalmente sera alguna base de datos, y pasarlo un ambito de objetos en C++.
  55 */
  56 class Loader : public Accesor {
  57 public:
  58   /**
  59      Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos.
  60      Para evitar ambigüedades este nombre deberia incluir la lista completa de \em namespaces
  61      a la que pertenece la clase.
  62      \return Una cadena con el nombre de este selector.
  63   */
  64   virtual const char* getClassName() const throw() { return "anna::dbos::Loader"; }
  65
  66 protected:
  67   /**
  68      Constructor.
  69      \param database Base de datos asociada a este cargador y que deberia servir para
  70      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  71      \param id Identificador de este accesor.
  72   */
  73   Loader(dbms::Database& database, const Id id = 0) : Accesor(database, id) {;}
  74
  75   /**
  76      Constructor.
  77      \param id Identificador de este accesor.
  78   */
  79   Loader(const Id id = 0) : Accesor(id) {;}
  80
  81   /**
  82      Devuelve el indice usado para ubicar en memoria el objeto que vamos a cargar.
  83      @return El indice usado para ubicar en memoria el objeto que vamos a cargar.
  84   */
  85   virtual Index getIndex() const throw(RuntimeException) = 0;
  86
  87   /**
  88    * Este método debe ser reescrito para poder obtener los datos de la clave principal usada para localizar
  89    * los objetos en un área del almacenamiento.
  90    *
  91    * \param crossedLoader Instancia del cargador alternativo que habrá calculado la clave principal en
  92    * a lo clave alternativa contenida en él.
  93    */
  94   virtual void upload(CrossedLoader& crossedLoader) throw(RuntimeException) {;}
  95
  96   friend class StorageArea;
  97 };
  98
  99 }
 100 }
 101
 102 #endif
 103
 104
 105