include/anna/dbms/String.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_String_hpp
  38 #define anna_dbms_String_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41
  42 #include <anna/dbms/Data.hpp>
  43
  44 namespace anna {
  45
  46 namespace dbms {
  47
  48 /**
  49    Cadena usada como entrada y/o salida de las sentencias SQL.
  50 */
  51 class String : public Data {
  52 public:
  53   /**
  54      Constructor.
  55      \param maxSize Tamao maximo que puede tener esta cadena. Deberia coincidir con el indicado
  56      por la columna con la que vaya a corresponder en la sentencia.
  57      \param isNulleable Indica si el dato puede tomar valores nulos.
  58   */
  59   explicit String(const int maxSize, const bool isNulleable = false) :
  60     Data(Type::String, maxSize, isNulleable) {
  61     Data::setBuffer(a_value = new char [maxSize + 1]);
  62     anna_memset(a_value, 0, maxSize + 1);
  63   }
  64
  65   /**
  66      Constructor copia.
  67      \param other Instancia de la que copiar.
  68   */
  69   String(const String& other) :
  70     Data(other),
  71     a_value(other.a_value) {
  72     const int maxSize = getMaxSize();
  73     Data::setBuffer(a_value = new char [maxSize + 1]);
  74     anna_memset(a_value, 0, maxSize + 1);
  75   }
  76
  77   /**
  78      Destructor.
  79   */
  80   virtual ~String() { delete [] a_value; }
  81
  82   /**
  83      Devuelve el contenido de la cadena.
  84      \return El contenido de la cadena.
  85      \warning Si el metodo Data::isNull devolvio \em true el resultado de este metodo no esta definido.
  86   */
  87   const char* getValue() const throw() { return a_value; }
  88
  89   /**
  90      Operador de copia.
  91      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
  92      indicado en el constructor obtendremos una excepcin.
  93      \return La instancia de esta cadena.
  94   */
  95   String& operator = (const String& str) throw(RuntimeException);
  96
  97   /**
  98      Operador de asignacin.
  99      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
 100      indicado en el constructor obtendremos una excepcin.
 101      \return La instancia de esta cadena.
 102   */
 103   String& operator = (const char* str) throw(RuntimeException);
 104
 105   /**
 106      Operador de asignacin.
 107      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
 108      indicado en el constructor obtendremos una excepcin.
 109      \return La instancia de esta cadena.
 110   */
 111   String& operator = (const std::string& str) throw(RuntimeException) { return operator= (str.c_str()); }
 112
 113   /**
 114      Operador de conversion. si el contenido de la columna sociada
 115      fue nulo este metodo devolvera NULL.
 116      \return El contenido de esta cadena.
 117   */
 118   operator const char*() const throw() { return (Data::isNull() == true) ? NULL : a_value; }
 119
 120   /**
 121      Elimina los espacios a la derecha de la cadena recibida.
 122      \return La misma cadena recibida pero con los espacios eliminados.
 123   */
 124   static char* strip(char *str) throw();
 125
 126   /**
 127      Devuelve una cadena con la informacion referente a esta instancia.
 128      \return Una cadena con la informacion referente a esta instancia.
 129   */
 130   virtual std::string asString() const throw();
 131
 132 private:
 133   char* a_value;
 134
 135   void do_clear() throw() { a_value [0] = 0; }
 136 };
 137
 138 }
 139 }
 140
 141 #endif
 142