include/anna/dbms/ShortBlock.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_ShortBlock_hpp
  38 #define anna_dbms_ShortBlock_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    La longitud del dato a tratar estara en 2048 y 4096 bytes, dependiendo
  55    del RDBMS concreto con el que estemos trabajando.
  56
  57    \see LongBlock
  58 */
  59 class ShortBlock : public Data {
  60 public:
  61   /**
  62
  63      Constructor.
  64      \param maxSize Tamao maximo que puede tener este bloque.
  65      \param isNulleable Indica si el dato puede tomar valores nulos.
  66   */
  67   explicit ShortBlock(const int maxSize, const bool isNulleable = false) :
  68     Data(Type::ShortBlock, maxSize, isNulleable),
  69     a_value(true) {
  70     a_value.allocate(maxSize);
  71     Data::setBuffer((void*) a_value.getData());
  72   }
  73
  74   /**
  75      Constructor copia.
  76      \param other Instancia de la que copiar.
  77   */
  78   ShortBlock(const ShortBlock& other) :
  79     Data(other),
  80     a_value(true) {
  81     a_value = other.a_value;
  82     Data::setBuffer((void*) a_value.getData());
  83   }
  84
  85   /**
  86      Destructor.
  87   */
  88   virtual ~ShortBlock() {;}
  89
  90   /**
  91      Devuelve el tamao actual de este dato.
  92      \return El tamao actual de este dato.
  93   */
  94   int getSize() const throw() { return a_value.getSize(); }
  95
  96   /**
  97      Devuelve el contenido de la este bloque de memoria.
  98      \return  Devuelve el contenido de la este bloque de memoria.
  99      \warning Si el metodo Data::isNull devolvio \em true el resultado de este metodo no esta definido.
 100   */
 101   const anna::DataBlock& getValue() const throw() { return a_value; }
 102
 103   /**
 104      Operador de asignacin.
 105      \param other Bloque del que copiar.
 106      \return La instancia de este bloque de memoria.
 107   */
 108   ShortBlock& operator = (const ShortBlock& other) throw(RuntimeException);
 109
 110   /**
 111      Operador de asignacin.
 112      \param value Valor que queremos a asignar.
 113      \return La instancia de esta cadena.
 114   */
 115   ShortBlock& operator = (const anna::DataBlock& value) throw(RuntimeException);
 116
 117   /**
 118      Operador de conversion.
 119      \return El anna::DataBlock asociado a esta instancia.
 120   */
 121   operator anna::DataBlock& () throw() { return a_value; }
 122
 123   /**
 124      Operador de conversion.
 125      \return El anna::DataBlock asociado a esta instancia.
 126   */
 127   operator const anna::DataBlock& () const throw() { return a_value; }
 128
 129   /**
 130      Devuelve una cadena con la informacion referente a esta instancia.
 131      \return Una cadena con la informacion referente a esta instancia.
 132   */
 133   std::string asString() const throw();
 134
 135 protected:
 136   anna::DataBlock a_value;
 137 };
 138
 139 }
 140 }
 141
 142 #endif
 143