include/anna/xml/Data.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_xml_Data_hpp
  38 #define anna_xml_Data_hpp
  39
  40 #include <string>
  41 #include <stdlib.h>
  42
  43 namespace anna {
  44
  45 namespace xml {
  46
  47 class Node;
  48
  49 /**
  50    Dato generico de nodo XML.
  51
  52    Cada nodo XML puede tener una serie indeterminada de dato XMLs. Por ejemplo:
  53
  54    \code
  55       <broadcast>
  56          <INetAddress Address="204.152.65.15" Port="2000"/>
  57          <INetAddress Address="204.152.65.47" Port="2002"/>
  58       </broadcast>
  59       <Indicador>
  60       Es es un texto libre
  61       </Indicador>
  62    \endcode
  63
  64    Cada uno de los nodos \em INetAddress tiene dos dato XMLs (\em Address y \em Port).
  65 */
  66 class Data {
  67 public:
  68   /**
  69      Devuelve el valor asociado a este dato XML.
  70      \return El valor asociado a este dato XML.
  71   */
  72   const std::string& getValue() const throw() { return a_value; }
  73
  74   /**
  75      Devuelve el valor asociado a este dato XML.
  76      \return El valor asociado a este dato XML.
  77   */
  78   const char* getCStringValue() const throw() { return a_value.c_str(); }
  79
  80   /**
  81      Devuelve el valor numerico asociado a este dato XML.
  82      \return El valor numerico asociado a este dato XML.
  83   */
  84   int getIntegerValue() const throw() { return atoi(a_value.c_str()); }
  85
  86   /**
  87    * Establece el valor de éste dato XML.
  88    * \param value Valor que tomará éste dato XML.
  89    */
  90   void setValue(const char* value) throw() { a_value = (value != NULL) ? value : ""; filter(a_value); }
  91
  92   /**
  93    * Establece el valor de éste dato XML.
  94    * \param value Valor que tomará éste dato XML.
  95    */
  96   void setValue(const std::string& value) throw() { a_value = value; }
  97
  98   /**
  99    * Establece el valor de éste dato XML.
 100    * \param value Valor que tomará éste dato XML.
 101    */
 102   void setValue(const int value) throw();
 103
 104   /**
 105      Devuelve una cadena con toda la informacion relevante de esta instancia.
 106      \return Una cadena con toda la informacion relevante de esta instancia.
 107   */
 108   virtual std::string asString() const throw();
 109
 110 protected:
 111   /**
 112    * Contructor.
 113    */
 114   Data() : a_owner(NULL) {;}
 115
 116 private:
 117   std::string a_value;
 118   Node* a_owner;
 119
 120   void setNode(Node* node) throw() { a_owner = node; }
 121
 122   /**
 123      Filtra la cadena recibida como parametro para asegurar que no contiene ninguna
 124      expresion o caracter que pudiera causar un error al establecer el xml::Data con
 125      este valor.
 126      \return La instancia de la cadena una vez modificada.
 127   */
 128   static const std::string& filter(const std::string& str) throw() { return str; }
 129
 130   friend class Node;
 131 };
 132
 133 }
 134 }
 135
 136 #endif