include/anna/dbms/OutputBind.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_OutputBind_hpp
  38 #define anna_dbms_OutputBind_hpp
  39
  40 #include <anna/dbms/Bind.hpp>
  41
  42 namespace anna {
  43
  44 namespace dbms {
  45
  46 class LongBlock;
  47
  48 /**
  49    Clase que facilita la interconexion entre las variables del ambito C++ y el ambito RDBMS.
  50
  51    A continuacion presentamos un ejemplo de uso detallado.
  52    \include db_blob.p/main.cc
  53 */
  54 class OutputBind : public Bind {
  55 public:
  56   /**
  57      Graba el valor de la variable anna::dbms::LongBlock asociada a esta OutputBind. Cualquier
  58      modificacion que necesitemos aplicar sobre la columnna de tipo se debera hacer mediante los
  59      metodos ofrecidos por la clase anna::dbms::LongBlock.
  60
  61      \warning Este metodo solo puede ser usado para variables de tipo dbms::Data::Type::LongBlock y
  62      siempre y cuando hayamos abierto el BLOB con una sentencia SQL de seleccion.
  63   */
  64   void write() const throw(RuntimeException, dbms::DatabaseException);
  65
  66 protected:
  67   OutputBind(const char* name, dbms::Data& value) : Bind(name, value) {;}
  68
  69 private:
  70   // este metodo no sera invocado nunca. A partir de un Output nunca hay que
  71   // convertir de C++ -> RDBMS
  72   void code() const throw(RuntimeException) {;}
  73
  74   virtual void do_write(const dbms::LongBlock&) const throw(RuntimeException, dbms::DatabaseException) = 0;
  75 };
  76
  77 }
  78 }
  79
  80 #endif
  81