include/anna/dbms/DatabaseException.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_dbms_DatabaseException_hpp
  38 #define anna_dbms_DatabaseException_hpp
  39
  40 #include <anna/core/Exception.hpp>
  41
  42 #include <anna/dbms/ResultCode.hpp>
  43
  44 namespace anna {
  45
  46 namespace dbms {
  47
  48 /**
  49    Exception ocurrida al acceder a algun servicio de la base de datos.
  50 */
  51 class DatabaseException : public Exception {
  52 public:
  53   /**
  54      Constructor.
  55
  56      @param resultCode Clase utilizada para transferir codigo de error entre el gestor de base de datos
  57      y nuestro programa. Entre otra informacion contiene el error ocurrido en la ultima operacion realizada.
  58      @param fromFile Fichero en el que se provoco la situacion de error.
  59      @param fromLine Linea del fichero en la que se provoco la situacion de error.
  60   */
  61   DatabaseException(const ResultCode& resultCode, const char* fromFile, const int fromLine) :
  62     Exception(resultCode.getErrorText(), "DatabaseException", fromFile, fromLine),
  63     a_resultCode(resultCode) {}
  64
  65   /**
  66      Constructor.
  67
  68      @param logicalName Nombre logico del elemento que genera la excepcion.
  69      @param resultCode Clase utilizada para transferir codigo de error entre el gestor de base de datos
  70      y nuestro programa. Entre otra informacion contiene el error ocurrido en la ultima operacion realizada.
  71      @param fromFile Fichero en el que se provoco la situacion de error.
  72      @param fromLine Linea del fichero en la que se provoco la situacion de error.
  73   */
  74   DatabaseException(const std::string& logicalName, const ResultCode& resultCode, const char* fromFile, const int fromLine) :
  75     Exception("", "DatabaseException", fromFile, fromLine),
  76     a_resultCode(resultCode) {
  77     std::string aux(logicalName);
  78     aux += ": ";
  79     aux += resultCode.getErrorText();
  80     setText(aux.c_str());
  81   }
  82
  83   /**
  84      Destructor.
  85   */
  86   virtual ~DatabaseException() throw() {;}
  87
  88   /**
  89      Devuelve el resultado de base de datos asociado a la excepcion
  90
  91      @return El resultado de base de datos asociado a la excepcion
  92   */
  93   const ResultCode& getResultCode() const throw() { return a_resultCode; }
  94
  95 private:
  96   const ResultCode a_resultCode;
  97 };
  98
  99 }
 100 }
 101
 102
 103 #endif
 104