include/anna/xml/Namespace.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_xml_Namespace_hpp
  38 #define anna_xml_Namespace_hpp
  39
  40 #include <string>
  41
  42 #include <anna/core/Allocator.hpp>
  43
  44 namespace anna {
  45
  46 namespace xml {
  47
  48 class Node;
  49
  50 /**
  51    Clase que modela los Namespaces que puede contener un documento XML.
  52
  53    Un namespace XML estará definido por un nombre y por una URI de la que obtener las definiciones.
  54
  55    La lista de namespaces asociados a un documento analizado estará asociado al nodo 'root' del
  56    documento, aunque el resto de los nodos podrá hacer referencia al mismo.
  57 */
  58 class Namespace {
  59 public:
  60   /**
  61    * Devuelve el nombre de este namespace.
  62    * \return  el nombre de este namespace.
  63    */
  64   const std::string& getName() const throw() { return a_name; }
  65
  66   /**
  67    * Devuelve la referencia asociada a este namespace.
  68    * \return la referencia asociada a este namespace.
  69    */
  70   const std::string& getReference() const throw() { return a_reference; }
  71
  72   /**
  73      Devuelve una cadena con toda la información relevante de esta instancia.
  74      \return Una cadena con toda la información relevante de esta instancia.
  75   */
  76   std::string asString() const throw();
  77
  78 private:
  79   /**
  80      Constructor.
  81   */
  82   Namespace() {;}
  83
  84   std::string a_name;
  85   std::string a_reference;
  86
  87   void setName(const char* name) throw() { a_name = name; }
  88   void setName(const std::string& name) throw() { a_name = name; }
  89   void setReference(const char* reference) throw() { a_reference = reference; }
  90
  91   friend class Allocator<Namespace>;
  92   friend class Node;
  93 };
  94
  95 }
  96 }
  97
  98 #endif