include/anna/dbms/StatementTranslator.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_dbms_StatementTranslator_hpp
  38 #define anna_dbms_StatementTranslator_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41
  42 namespace anna {
  43
  44 namespace dbms {
  45
  46 class Database;
  47
  48 /**
  49  * Clase que ajustar de forma transparente las diferencias de tratamiento que tiene las
  50  * sentencias SQL en los distintos motores de base de datos. De esta forma una aplicación
  51  * originariamente escrita para un determinado RDBMS no tendrá que hacer ningún cambio
  52  * en las sentencias SQL al cambiar a otro RDBMS.
  53  *
  54  * Por ejemplo para indicar los parámetros de entrada en Oracle se indica con un
  55  * literal precedido de ':' o '&'. Con lo que la sentencia podría quedar como:
  56  * \code
  57  * insert into foo (field1, field2) values (:f1, :f2)
  58  * \endcode
  59  *
  60  * En PosgreSQL (tambien sorpotado en Oracle) quedaría algo así:
  61  * \code
  62  * insert into foo (field1, field2) values (&f1, &f2)
  63  * \endcode
  64  *
  65  * Mientras que en MySQL la expresión debería ser como:
  66  * \code
  67  * insert into foo (field1, field2) values (?, ?);
  68  * \endcode
  69  *
  70  * \see anna::dbms::Database::setStatementTranslator
  71  */
  72 class StatementTranslator {
  73   /**
  74    * Devuelve el nombre lógico de este traductor.
  75    * \return el nombre lógico de este traductor.
  76    */
  77   const char* getName() const throw() { return a_name; }
  78
  79 protected:
  80   /**
  81    * Constructor.
  82    * \param name Nombre lógico del traductor.
  83    */
  84   explicit StatementTranslator(const char* name) : a_name(name) {;}
  85
  86   /**
  87    * Se invoca automáticamente desde anna::dbms::Database::createStatement si la
  88    * instancia de la base de datos tiene asociada alguna instancia heredada de esta clase.
  89    *
  90    * Ã\89ste metodo sólo se invoca una vez para cada una de las sentencias definidas sobre
  91    * la base de datos, por lo que la traducción de sentencias SQL tiene un consumo despreciable
  92    * con respecto al tiempo total del proceso.
  93    *
  94    * \param statement Sentencia SQL original.
  95    * \return La sentencia SQL correspondiente con la original, pero tratada para que
  96    * pueda ser interpretada correctamente por el motor de base de datos sobre el que
  97    * se va a ejecutar.
  98    */
  99   virtual const char* apply(const char* statement) throw(RuntimeException) = 0;
 100
 101 private:
 102   const char* a_name;
 103
 104   StatementTranslator(const StatementTranslator&);
 105
 106   friend class Database;
 107 };
 108
 109 }
 110 }
 111
 112 #endif
 113
 114