Add no-deprecated to warnings due to dynamic exceptions.
[anna.git] / include / anna / dbms / String.hpp
1 // ANNA - Anna is Not Nothingness Anymore                                                         //
2 //                                                                                                //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
4 //                                                                                                //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
7
8
9 #ifndef anna_dbms_String_hpp
10 #define anna_dbms_String_hpp
11
12 #include <anna/core/RuntimeException.hpp>
13
14 #include <anna/dbms/Data.hpp>
15
16 namespace anna {
17
18 namespace dbms {
19
20 /**
21    Cadena usada como entrada y/o salida de las sentencias SQL.
22 */
23 class String : public Data {
24 public:
25   /**
26      Constructor.
27      \param maxSize Tamao maximo que puede tener esta cadena. Deberia coincidir con el indicado
28      por la columna con la que vaya a corresponder en la sentencia.
29      \param isNulleable Indica si el dato puede tomar valores nulos.
30   */
31   explicit String(const int maxSize, const bool isNulleable = false) :
32     Data(Type::String, maxSize, isNulleable) {
33     Data::setBuffer(a_value = new char [maxSize + 1]);
34     anna_memset(a_value, 0, maxSize + 1);
35   }
36
37   /**
38      Constructor copia.
39      \param other Instancia de la que copiar.
40   */
41   String(const String& other) :
42     Data(other),
43     a_value(other.a_value) {
44     const int maxSize = getMaxSize();
45     Data::setBuffer(a_value = new char [maxSize + 1]);
46     anna_memset(a_value, 0, maxSize + 1);
47   }
48
49   /**
50      Destructor.
51   */
52   virtual ~String() { delete [] a_value; }
53
54   /**
55      Devuelve el contenido de la cadena.
56      \return El contenido de la cadena.
57      \warning Si el metodo Data::isNull devolvio \em true el resultado de este metodo no esta definido.
58   */
59   const char* getValue() const throw() { return a_value; }
60
61   /**
62      Operador de copia.
63      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
64      indicado en el constructor obtendremos una excepcin.
65      \return La instancia de esta cadena.
66   */
67   String& operator = (const String& str) throw(RuntimeException);
68
69   /**
70      Operador de asignacin.
71      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
72      indicado en el constructor obtendremos una excepcin.
73      \return La instancia de esta cadena.
74   */
75   String& operator = (const char* str) throw(RuntimeException);
76
77   /**
78      Operador de asignacin.
79      \param str Cadena de la que copiar. Si la longitud de la cadena sobrepasa el tamao maximo
80      indicado en el constructor obtendremos una excepcin.
81      \return La instancia de esta cadena.
82   */
83   String& operator = (const std::string& str) throw(RuntimeException) { return operator= (str.c_str()); }
84
85   /**
86      Operador de conversion. si el contenido de la columna sociada
87      fue nulo este metodo devolvera NULL.
88      \return El contenido de esta cadena.
89   */
90   operator const char*() const throw() { return (Data::isNull() == true) ? NULL : a_value; }
91
92   /**
93      Elimina los espacios a la derecha de la cadena recibida.
94      \return La misma cadena recibida pero con los espacios eliminados.
95   */
96   static char* strip(char *str) throw();
97
98   /**
99      Devuelve una cadena con la informacion referente a esta instancia.
100      \return Una cadena con la informacion referente a esta instancia.
101   */
102   virtual std::string asString() const throw();
103
104 private:
105   char* a_value;
106
107   void do_clear() throw() { a_value [0] = 0; }
108 };
109
110 }
111 }
112
113 #endif
114