include/anna/dbms.oracle/Database.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_dbms_oracle_Database_hpp
  10 #define anna_dbms_oracle_Database_hpp
  11
  12 #include <anna/dbms/Database.hpp>
  13 #include <anna/dbms/DatabaseException.hpp>
  14
  15 struct OCIEnv;
  16 struct OCIError;
  17
  18 namespace anna {
  19
  20 namespace dbms {
  21
  22 namespace oracle {
  23
  24 /**
  25    Clase que modela la interaccion entre la RDMS Oracle (tm) y nuestra aplicacion.
  26
  27    \warning La definicion conexiones y clusters debe hacerse antes de invocar al metodo Application::start,
  28    o bien, en el metodo Application::initialize.
  29 */
  30 class Database : public dbms::Database {
  31 public:
  32   /**
  33      Contructor.
  34      \param dbmsName Nombre de la base de datos.
  35   */
  36   Database(const char* dbmsName);
  37
  38   /**
  39      Contructor.
  40      \param componentName Nombre logico de la base de datos por que el podemos buscar este compoenente.
  41      \param dbmsName Nombre de la base de datos.
  42   */
  43   Database(const char* componentName, const char* dbmsName);
  44
  45   /**
  46      Destructor.
  47   */
  48   virtual ~Database();
  49
  50   /**
  51      Devuelve el manejador de error asociado a esta base de datos.
  52      \return El manejador de error asociado a esta base de datos.
  53   */
  54   OCIError* getErrorHandler() throw() { return a_error; }
  55
  56   /**
  57      Operador de conversion.
  58      \return El puntero al entorno asociado a esta base de datos.
  59   */
  60   operator OCIEnv*() throw() { return a_env; }
  61
  62   /**
  63      Devuelve la cadena por la que podemos buscar el componente.
  64      \return La cadena por la que podemos buscar el componente.
  65      \see Application::find
  66   */
  67   static const char* getClassName() { return "anna::dbms::oracle::Database"; }
  68
  69   /**
  70    * Devuelve el caracter usado como punto decimal, obtenido a partir de la configuración establecida
  71    * por la variables de entorno, LANG, LC_NUMERIC, etc, etc.
  72    *
  73    * \return El caracter usado como punto decimal.
  74    *
  75    * \warning Metodo exclusivamente de uso interno.
  76    */
  77   static char getDecimalPoint() throw() { return st_decimalPoint; }
  78
  79 private:
  80   OCIEnv* a_env;
  81   OCIError* a_error;
  82
  83   static char st_decimalPoint;
  84
  85   void do_initialize() throw(RuntimeException);
  86
  87   dbms::Connection* allocateConnection(const std::string& name, const char* user, const char* password)
  88   throw(RuntimeException);
  89
  90   dbms::Statement* allocateStatement(const char* name, const std::string& expression, const bool isCritical)
  91   throw(RuntimeException);
  92
  93   dbms::InputBind* allocateInputBind(const char* name, Data&)
  94   throw(RuntimeException);
  95   void deallocate(dbms::InputBind* inputBind) throw();
  96
  97   dbms::OutputBind* allocateOutputBind(const char* name, Data&)
  98   throw(RuntimeException);
  99   void deallocate(dbms::OutputBind* outputBind) throw();
 100
 101   static void initializeDecimalPoint() throw(RuntimeException);
 102 };
 103
 104 #ifdef ANNA_RDBMS_TRACE
 105 #define anna_dbms_oracle_check(a,error) \
 106     { \
 107        Logger::write (Logger::Debug, (#a), __FILE__, __LINE__); \
 108        const sword status = (a); \
 109        if (status != OCI_SUCCESS) { \
 110           anna::dbms::oracle::ResultCode resultCode (status, (error)); \
 111           throw DatabaseException (resultCode, __FILE__, __LINE__);  \
 112        } \
 113     }
 114 #else
 115 #define anna_dbms_oracle_check(a,error) \
 116     { \
 117        const sword status = (a); \
 118        if (status != OCI_SUCCESS) { \
 119           anna::dbms::oracle::ResultCode resultCode (status, (error)); \
 120           throw DatabaseException (resultCode, __FILE__, __LINE__);  \
 121        } \
 122     }
 123 #endif
 124 }
 125 }
 126 }
 127
 128 #endif