include/anna/dbos/CrossedLoader.hpp

   1 // ANNA - Anna is Not 'N' 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_CrossedLoader_hpp
  38 #define anna_dbos_CrossedLoader_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 Loader;
  51
  52 /**
  53  * Interfaz que deben cumplir los cargadores cruzados. Un cargador cruzado facilita que una
  54  * misma clase pueda ser cargada usando varios criterios de búsqueda.
  55  *
  56  * El  criterio de búsqueda más usado y que debería ser más óptimo será desarrollado
  57  * mediante la definición del anna::dbos::Loader específico. El resto de criterios de búsqueda,
  58  * los cargadores cruzados,  deberían ser capaces obtener los datos usados como clave en el criterio
  59  * principal, para a partir de ahí poder aplicar el criterio de búsqueda principal.
  60  *
  61  * Cada cargador cruzado podría tener una lista de pares (clave_alternativa, clave_principal) que permitirá
  62  * acelerar las búsquedas de la clave principal, en base a la clave alternativa usada en este cargador.
  63  *
  64  * Para obtener los datos de la clave principal en base a los datos de la clave alternativa habrá que
  65  * acceder al medio físico.
  66  *
  67  * Para optimizar el acceso a los pares (Clave alternativa, Clave Principal) se podría usar una
  68  * instancia del tipo anna::LRUMap.
  69 */
  70 class CrossedLoader : public Accesor {
  71 public:
  72   /**
  73      Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos.
  74      Para evitar ambigüedades este nombre deberia incluir la lista completa de \em namespaces
  75      a la que pertenece la clase.
  76      \return Una cadena con el nombre de este selector.
  77   */
  78   virtual const char* getClassName() const throw() { return "anna::dbos::CrossedLoader"; }
  79
  80 protected:
  81   /**
  82      Constructor.
  83      \param database Base de datos asociada a este cargador y que deberia servir para
  84      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  85      \param id Identificador de este accesor.
  86   */
  87   CrossedLoader(dbms::Database& database, const Id id = 0) : Accesor(database, id) {;}
  88
  89   /**
  90      Constructor.
  91      \param database Base de datos asociada a este cargador y que deberia servir para
  92      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  93      \param id Identificador de este accesor.
  94      \param emode Modo de actuar en caso de no encontrar el dato buscado.
  95   */
  96   CrossedLoader(dbms::Database& database, const Id id, const Exception::Mode::_v emode) : Accesor(database, id, emode) {;}
  97
  98   /**
  99      Este método debe ser reescrito para que permita localizar la información del objeto, que posiblemente
 100      esté ubicado en la lista de objetos de este cargador cruzado.
 101
 102      @return \em true si se ha localizado la información la clave primaria del objeto en su lista de pares
 103      o \em false en otro caso.
 104   */
 105   virtual bool seek() const throw() { return false; }
 106
 107   /**
 108    * Este método debe ser reescrito para que se pueda actualizar la lista de pares (clave_alternativa, clave_principal)
 109    * que permitirá acelear las posteriores búsquedas.
 110    *
 111    * \param loader Instancia del cargador principal que habrá compuesto la clave principal con los suministrados por
 112    * esta instancia.
 113    */
 114   virtual void download(Loader& loader) throw() {;}
 115
 116   friend class StorageArea;
 117 };
 118
 119 }
 120 }
 121
 122 #endif
 123
 124
 125