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::setElementNamespacePrefix()\r
  52          */\r
  53         void setElementNamespacePrefix(const XMLCh* prefix) {\r
  54             m_elementQname.setPrefix(prefix);\r
  55         }\r
  56 \r
  57         /**\r
  58          * @see XMLObject::getNamespaces()\r
  59          */\r
  60         const std::set<Namespace>& getNamespaces() const {\r
  61             return m_namespaces;\r
  62         }\r
  63     \r
  64         /**\r
  65          * @see XMLObject::addNamespace()\r
  66          */\r
  67         void addNamespace(const Namespace& ns) const {\r
  68             if (ns.alwaysDeclare() || m_namespaces.find(ns)==m_namespaces.end()) {\r
  69                 m_namespaces.insert(ns);\r
  70             }\r
  71         }\r
  72     \r
  73         /**\r
  74          * @see XMLObject::removeNamespace()\r
  75          */\r
  76         void removeNamespace(const Namespace& ns) {\r
  77             m_namespaces.erase(ns);\r
  78         }\r
  79         \r
  80         /**\r
  81          * @see XMLObject::getSchemaType()\r
  82          */\r
  83         const QName* getSchemaType() const {\r
  84             return m_typeQname;\r
  85         }\r
  86     \r
  87         /**\r
  88          * @see XMLObject::setSchemaType()\r
  89          */\r
  90         void setSchemaType(const QName* type) {\r
  91             delete m_typeQname;\r
  92             m_typeQname = NULL;\r
  93             if (type) {\r
  94                 m_typeQname = new QName(*type);\r
  95                 addNamespace(Namespace(type->getNamespaceURI(), type->getPrefix()));\r
  96             }\r
  97         }\r
  98     \r
  99         /**\r
 100          * @see XMLObject::hasParent()\r
 101          */\r
 102         bool hasParent() const {\r
 103             return m_parent != NULL;\r
 104         }\r
 105      \r
 106         /**\r
 107          * @see XMLObject::getParent()\r
 108          */\r
 109         XMLObject* getParent() const {\r
 110             return m_parent;\r
 111         }\r
 112     \r
 113         /**\r
 114          * @see XMLObject::setParent()\r
 115          */\r
 116         void setParent(XMLObject* parent) {\r
 117             m_parent = parent;\r
 118         }\r
 119 \r
 120         /**\r
 121          * @see XMLObject::hasChildren()\r
 122          */\r
 123         bool hasChildren() const {\r
 124             return !m_children.empty();\r
 125         }\r
 126 \r
 127         /**\r
 128          * @see XMLObject::getOrderedChildren()\r
 129          */\r
 130         const std::list<XMLObject*>& getOrderedChildren() const {\r
 131             return m_children;\r
 132         }\r
 133 \r
 134      protected:\r
 135         /**\r
 136          * Constructor\r
 137          * \r
 138          * @param namespaceURI the namespace the element is in\r
 139          * @param elementLocalName the local name of the XML element this Object represents\r
 140          * @param namespacePrefix the namespace prefix to use\r
 141          */\r
 142         AbstractXMLObject(const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL);\r
 143 \r
 144         /**\r
 145          * Underlying list of child objects.\r
 146          * Manages the lifetime of the children.\r
 147          */\r
 148         std::list<XMLObject*> m_children;\r
 149 \r
 150         /**\r
 151          * Set of namespaces associated with the object.\r
 152          */\r
 153         mutable std::set<Namespace> m_namespaces;\r
 154 \r
 155         /**\r
 156          * Logging object.\r
 157          */\r
 158         void* m_log;\r
 159 \r
 160     private:\r
 161         XMLObject* m_parent;\r
 162         QName m_elementQname;\r
 163         QName* m_typeQname;\r
 164     };\r
 165 \r
 166 };\r
 167 \r
 168 #if defined (_MSC_VER)\r
 169     #pragma warning( pop )\r
 170 #endif\r
 171 \r
 172 #endif /* __xmltooling_abstractxmlobj_h__ */\r