include/anna/dbos/CrossedLoader.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_CrossedLoader_hpp
  10 #define anna_dbos_CrossedLoader_hpp
  11
  12 #include <anna/dbos/Accesor.hpp>
  13
  14 namespace anna {
  15
  16 namespace dbms {
  17 class Database;
  18 }
  19
  20 namespace dbos {
  21
  22 class Loader;
  23
  24 /**
  25  * Interfaz que deben cumplir los cargadores cruzados. Un cargador cruzado facilita que una
  26  * misma clase pueda ser cargada usando varios criterios de búsqueda.
  27  *
  28  * El  criterio de búsqueda más usado y que debería ser más óptimo será desarrollado
  29  * mediante la definición del anna::dbos::Loader específico. El resto de criterios de búsqueda,
  30  * los cargadores cruzados,  deberían ser capaces obtener los datos usados como clave en el criterio
  31  * principal, para a partir de ahí poder aplicar el criterio de búsqueda principal.
  32  *
  33  * Cada cargador cruzado podría tener una lista de pares (clave_alternativa, clave_principal) que permitirá
  34  * acelerar las búsquedas de la clave principal, en base a la clave alternativa usada en este cargador.
  35  *
  36  * Para obtener los datos de la clave principal en base a los datos de la clave alternativa habrá que
  37  * acceder al medio físico.
  38  *
  39  * Para optimizar el acceso a los pares (Clave alternativa, Clave Principal) se podría usar una
  40  * instancia del tipo anna::LRUMap.
  41 */
  42 class CrossedLoader : public Accesor {
  43 public:
  44   /**
  45      Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos.
  46      Para evitar ambigüedades este nombre deberia incluir la lista completa de \em namespaces
  47      a la que pertenece la clase.
  48      \return Una cadena con el nombre de este selector.
  49   */
  50   virtual const char* getClassName() const throw() { return "anna::dbos::CrossedLoader"; }
  51
  52 protected:
  53   /**
  54      Constructor.
  55      \param database Base de datos asociada a este cargador y que deberia servir para
  56      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  57      \param id Identificador de este accesor.
  58   */
  59   CrossedLoader(dbms::Database& database, const Id id = 0) : Accesor(database, id) {;}
  60
  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      \param emode Modo de actuar en caso de no encontrar el dato buscado.
  67   */
  68   CrossedLoader(dbms::Database& database, const Id id, const Exception::Mode::_v emode) : Accesor(database, id, emode) {;}
  69
  70   /**
  71      Este método debe ser reescrito para que permita localizar la información del objeto, que posiblemente
  72      esté ubicado en la lista de objetos de este cargador cruzado.
  73
  74      @return \em true si se ha localizado la información la clave primaria del objeto en su lista de pares
  75      o \em false en otro caso.
  76   */
  77   virtual bool seek() const throw() { return false; }
  78
  79   /**
  80    * Este método debe ser reescrito para que se pueda actualizar la lista de pares (clave_alternativa, clave_principal)
  81    * que permitirá acelear las posteriores búsquedas.
  82    *
  83    * \param loader Instancia del cargador principal que habrá compuesto la clave principal con los suministrados por
  84    * esta instancia.
  85    */
  86   virtual void download(Loader& loader) throw() {;}
  87
  88   friend class StorageArea;
  89 };
  90
  91 }
  92 }
  93
  94 #endif
  95
  96
  97