include/anna/dbms/LongBlock.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_LongBlock_hpp
  38 #define anna_dbms_LongBlock_hpp
  39
  40 #include <string>
  41
  42 #include <anna/core/RuntimeException.hpp>
  43 #include <anna/core/DataBlock.hpp>
  44
  45 #include <anna/dbms/Data.hpp>
  46
  47 namespace anna {
  48
  49 namespace dbms {
  50
  51 /**
  52    Bloque de datos usado como entrada y/o salida de las sentencias SQL.
  53
  54    A diferencia del tipo de datos ShortBlock, en principio, no tiene ninguna limitacion
  55    en cuanto a la longitud del campo que vamos a tratar. Por contra, dependiendo del motor
  56    de base de datos que vayamos a usar puede tener un tratamiento especial a la hora de
  57    grabarlo en la base de datos.
  58
  59    \see ShortBlock
  60 */
  61 class LongBlock : public Data {
  62 public:
  63   /**
  64      Constructor.
  65      \param isNulleable Indica si el dato puede tomar valores nulos.
  66   */
  67   explicit LongBlock(const bool isNulleable = false) :
  68     Data(Type::LongBlock, 0, isNulleable),
  69     a_value(true) {
  70     Data::setBuffer((void*) NULL);
  71   }
  72
  73   /**
  74      Constructor copia.
  75      \param other Instancia de la que copiar.
  76   */
  77   LongBlock(const LongBlock& other) :
  78     Data(other),
  79     a_value(true) {
  80     a_value = other.a_value;
  81   }
  82
  83   /**
  84      Destructor.
  85   */
  86   virtual ~LongBlock() {;}
  87
  88   /**
  89      Devuelve el tamao actual de este dato.
  90      \return El tamao actual de este dato.
  91   */
  92   int getSize() const throw() { return a_value.getSize(); }
  93
  94   /**
  95      Devuelve el contenido de la este bloque de memoria.
  96      \return  Devuelve el contenido de la este bloque de memoria.
  97      \warning Si el metodo Data::isNull devolvio \em true el resultado de este metodo no esta definido.
  98   */
  99   const anna::DataBlock& getValue() const throw() { return a_value; }
 100
 101   /**
 102      Devuelve el contenido de la este bloque de memoria.
 103      \return  Devuelve el contenido de la este bloque de memoria.
 104      \warning Si el metodo Data::isNull devolvio \em true el resultado de este metodo no esta definido.
 105   */
 106   anna::DataBlock& getValue() throw() { return a_value; }
 107
 108   /**
 109      Operador de asignacin.
 110      \param other Bloque del que copiar.
 111      \return La instancia de este bloque de memoria.
 112   */
 113   LongBlock& operator = (const LongBlock& other) throw(RuntimeException);
 114
 115   /**
 116      Operador de asignacin.
 117      \param value Valor que queremos a asignar.
 118      \return La instancia de esta cadena.
 119   */
 120   LongBlock& operator = (const anna::DataBlock& value) throw(RuntimeException);
 121
 122   /**
 123      Operador de conversion.
 124      \return El anna::DataBlock asociado a esta instancia.
 125   */
 126   operator anna::DataBlock& () throw() { return a_value; }
 127
 128   /**
 129      Operador de conversion.
 130      \return El anna::DataBlock asociado a esta instancia.
 131   */
 132   operator const anna::DataBlock& () const throw() { return a_value; }
 133
 134   /**
 135      Devuelve una cadena con la informacion referente a esta instancia.
 136      \return Una cadena con la informacion referente a esta instancia.
 137   */
 138   std::string asString() const throw();
 139
 140 protected:
 141   anna::DataBlock a_value;
 142
 143   void do_clear() throw() { a_value.clear(); }
 144 };
 145
 146 }
 147 }
 148
 149 #endif
 150