1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_dbms_StatementTranslator_hpp
38 #define anna_dbms_StatementTranslator_hpp
40 #include <anna/core/RuntimeException.hpp>
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.
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:
57 * insert into foo (field1, field2) values (:f1, :f2)
60 * En PosgreSQL (tambien sorpotado en Oracle) quedaría algo así:
62 * insert into foo (field1, field2) values (&f1, &f2)
65 * Mientras que en MySQL la expresión debería ser como:
67 * insert into foo (field1, field2) values (?, ?);
70 * \see anna::dbms::Database::setStatementTranslator
72 class StatementTranslator {
74 * Devuelve el nombre lógico de este traductor.
75 * \return el nombre lógico de este traductor.
77 const char* getName() const throw() { return a_name; }
82 * \param name Nombre lógico del traductor.
84 explicit StatementTranslator(const char* name) : a_name(name) {;}
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.
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.
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
99 virtual const char* apply(const char* statement) throw(RuntimeException) = 0;
104 StatementTranslator(const StatementTranslator&);
106 friend class Database;