Updated license
[anna.git] / include / anna / dbms.oracle / Statement.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_oracle_Statement_hpp
38 #define anna_dbms_oracle_Statement_hpp
39
40 #include <anna/dbms/Statement.hpp>
41
42 struct OCIStmt;
43 struct OCIError;
44
45 namespace anna {
46
47 namespace dbms {
48
49 class Connection;
50
51 namespace oracle {
52
53 /**
54    Clase que facilita la ejecucion de sentencias SQL a traves del RDBMS Oracle (tm).
55
56    Esta clase no puede usarse directamente, ya que la capa ANNA.dbms obliga a que todas las peticiones
57    se hagan atraves de una instancia anna::dbms::Statement.
58
59    Para obtener la instancia de un comando para una determinada base de datos habra que instanciar
60    dicha base de datos e invocar al metodo createStatement. Independientemente del tipo de comando
61    particular que la base de datos retorne, debemos asignarlo a un puntero de tipo anna::dbms::Statement.
62  */
63 class Statement : public dbms::Statement {
64 public:
65   /**
66      Destructor.
67   */
68   virtual ~Statement();
69
70   /**
71      Operador de conversion.
72      \return El puntero OCI de esta sentencia.
73   */
74   operator OCIStmt*() throw() { return a_ociStmt; }
75
76 private:
77   OCIStmt* a_ociStmt;
78   OCIError* a_ociError;
79   bool a_firstFetch;
80
81   Statement(Database& database, const char* name, const char* expression, const bool isCritical) :
82     dbms::Statement(database, name, expression, isCritical),
83     a_ociStmt(NULL),
84     a_ociError(NULL) {}
85
86   Statement(Database& database, const char* name, const std::string& expression, const bool isCritical) :
87     dbms::Statement(database, name, expression, isCritical),
88     a_ociStmt(NULL),
89     a_ociError(NULL) {}
90
91   void prepare(dbms::Connection* connection) throw(RuntimeException, DatabaseException);
92   dbms::ResultCode execute(dbms::Connection* connection) throw(RuntimeException, DatabaseException);
93   bool fetch() throw(RuntimeException, DatabaseException);
94
95   friend class Database;
96 };
97
98 }
99 }
100 }
101
102 #endif
103