include/anna/xml/Attribute.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_Attribute_hpp
  38 #define anna_xml_Attribute_hpp
  39
  40 #include <anna/core/Allocator.hpp>
  41 #include <anna/xml/Data.hpp>
  42
  43 namespace anna {
  44
  45 namespace xml {
  46
  47 class Namespace;
  48
  49 /**
  50    Atributo de nodo XML.
  51
  52    Cada nodo XML puede tener una serie indeterminada de atributos. 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    \endcode
  60
  61    Cada uno de los nodos \em INetAddress tiene dos atributos (\em Address y \em Port).
  62 */
  63 class Attribute : public Data {
  64 public:
  65   /**
  66      Devuelve el nombre de este atributo.
  67      \return Nombre de este atributo.
  68   */
  69   const char* getName() const throw() { return a_name.c_str(); }
  70
  71   /**
  72    * Devuelve el namespace asociado a este atributo. Puede ser NULL.
  73    * \return el namespace asociado a este atributo. Puede ser NULL.
  74    */
  75   const Namespace* getNamespace() const throw() { return a_namespace; }
  76
  77   /**
  78    * Devuelve el nombre del nodo.
  79    * \return El nombre del nodo.
  80    */
  81   const std::string& getNameAsString() const throw() { return a_name; }
  82
  83   /**
  84      Devuelve una cadena con toda la informacion relevante de esta instancia.
  85      \return Una cadena con toda la informacion relevante de esta instancia.
  86   */
  87   std::string asString() const throw();
  88
  89 private:
  90   std::string a_name;
  91   const Namespace* a_namespace;
  92
  93   /* Para evitar que se pueda crear desde el exterior */
  94   Attribute() : Data(), a_namespace(NULL) {;}
  95
  96   void setName(const char* name) throw() { a_name = name; }
  97   void setNamespace(const Namespace* _namespace) throw() { a_namespace = _namespace; }
  98
  99   friend class Node;
 100   friend class Allocator<Attribute>;
 101 };
 102
 103 }
 104 }
 105
 106 #endif