xmltooling/AbstractXMLObject.h

   1 /*\r
   2 *  Copyright 2001-2006 Internet2\r
   3  * \r
   4 * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file AbstractXMLObject.h\r
  19  * \r
  20  * An abstract implementation of XMLObject.\r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_abstractxmlobj_h__)\r
  24 #define __xmltooling_abstractxmlobj_h__\r
  25 \r
  26 #include <xmltooling/XMLObject.h>\r
  27 \r
  28 #if defined (_MSC_VER)\r
  29     #pragma warning( push )\r
  30     #pragma warning( disable : 4250 4251 )\r
  31 #endif\r
  32 \r
  33 namespace xmltooling {\r
  34 \r
  35     /**\r
  36      * An abstract implementation of XMLObject.\r
  37      */\r
  38     class XMLTOOL_API AbstractXMLObject : public virtual XMLObject\r
  39     {\r
  40     public:\r
  41         virtual ~AbstractXMLObject();\r
  42 \r
  43         /**\r
  44          * @see XMLObject::getElementQName()\r
  45          */\r
  46         const QName& getElementQName() const {\r
  47             return m_elementQname;\r
  48         }\r
  49 \r
  50         /**\r
  51          * @see XMLObject::getNamespaces()\r
  52          */\r
  53         const std::set<Namespace>& getNamespaces() const {\r
  54             return m_namespaces;\r
  55         }\r
  56     \r
  57         /**\r
  58          * @see XMLObject::addNamespace()\r
  59          */\r
  60         void addNamespace(const Namespace& ns) const {\r
  61             if (ns.alwaysDeclare() || m_namespaces.find(ns)==m_namespaces.end()) {\r
  62                 m_namespaces.insert(ns);\r
  63             }\r
  64         }\r
  65     \r
  66         /**\r
  67          * @see XMLObject::removeNamespace()\r
  68          */\r
  69         void removeNamespace(const Namespace& ns) {\r
  70             m_namespaces.erase(ns);\r
  71         }\r
  72         \r
  73         /**\r
  74          * @see XMLObject::getSchemaType()\r
  75          */\r
  76         const QName* getSchemaType() const {\r
  77             return m_typeQname;\r
  78         }\r
  79     \r
  80         /**\r
  81          * @see XMLObject::setSchemaType()\r
  82          */\r
  83         void setSchemaType(const QName* type) {\r
  84             delete m_typeQname;\r
  85             m_typeQname = NULL;\r
  86             if (type) {\r
  87                 m_typeQname = new QName(*type);\r
  88                 addNamespace(Namespace(type->getNamespaceURI(), type->getPrefix()));\r
  89             }\r
  90         }\r
  91     \r
  92         /**\r
  93          * @see XMLObject::hasParent()\r
  94          */\r
  95         bool hasParent() const {\r
  96             return m_parent != NULL;\r
  97         }\r
  98      \r
  99         /**\r
 100          * @see XMLObject::getParent()\r
 101          */\r
 102         XMLObject* getParent() const {\r
 103             return m_parent;\r
 104         }\r
 105     \r
 106         /**\r
 107          * @see XMLObject::setParent()\r
 108          */\r
 109         void setParent(XMLObject* parent) {\r
 110             m_parent = parent;\r
 111         }\r
 112 \r
 113         /**\r
 114          * @see XMLObject::hasChildren()\r
 115          */\r
 116         bool hasChildren() const {\r
 117             return !m_children.empty();\r
 118         }\r
 119 \r
 120         /**\r
 121          * @see XMLObject::getOrderedChildren()\r
 122          */\r
 123         const std::list<XMLObject*>& getOrderedChildren() const {\r
 124             return m_children;\r
 125         }\r
 126 \r
 127      protected:\r
 128         /**\r
 129          * Constructor\r
 130          * \r
 131          * @param namespaceURI the namespace the element is in\r
 132          * @param elementLocalName the local name of the XML element this Object represents\r
 133          * @param namespacePrefix the namespace prefix to use\r
 134          */\r
 135         AbstractXMLObject(const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL);\r
 136 \r
 137         /**\r
 138          * Underlying list of child objects.\r
 139          * Manages the lifetime of the children.\r
 140          */\r
 141         std::list<XMLObject*> m_children;\r
 142 \r
 143         /**\r
 144          * Set of namespaces associated with the object.\r
 145          */\r
 146         mutable std::set<Namespace> m_namespaces;\r
 147 \r
 148         /**\r
 149          * Logging object.\r
 150          */\r
 151         void* m_log;\r
 152 \r
 153     private:\r
 154         XMLObject* m_parent;\r
 155         QName m_elementQname;\r
 156         QName* m_typeQname;\r
 157     };\r
 158 \r
 159 };\r
 160 \r
 161 #if defined (_MSC_VER)\r
 162     #pragma warning( pop )\r
 163 #endif\r
 164 \r
 165 #endif /* __xmltooling_abstractxmlobj_h__ */\r