xmltooling/impl/UnknownElement.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 UnknownElement.h\r
  19  * \r
  20  * Basic implementations suitable for use as defaults for unrecognized content\r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_unkelement_h__)\r
  24 #define __xmltooling_unkelement_h__\r
  25 \r
  26 #include "internal.h"\r
  27 #include "AbstractDOMCachingXMLObject.h"\r
  28 #include "XMLObjectBuilder.h"\r
  29 #include "io/Marshaller.h"\r
  30 #include "io/Unmarshaller.h"\r
  31 \r
  32 #include <string>\r
  33 \r
  34 #if defined (_MSC_VER)\r
  35     #pragma warning( push )\r
  36     #pragma warning( disable : 4250 4251 )\r
  37 #endif\r
  38 \r
  39 namespace xmltooling {\r
  40 \r
  41     /**\r
  42      * Implementation class for unrecognized DOM elements.\r
  43      * Purpose is to wrap the DOM and do any necessary caching/reconstruction\r
  44      * when a DOM has to cross into a new document.\r
  45      */\r
  46     class XMLTOOL_DLLLOCAL UnknownElementImpl : public AbstractDOMCachingXMLObject\r
  47     {\r
  48     public:\r
  49         UnknownElementImpl() {}\r
  50 \r
  51         /**\r
  52          * Overridden to ensure XML content of DOM isn't lost.\r
  53          * \r
  54          * @see DOMCachingXMLObject::releaseDOM()\r
  55          */\r
  56         void releaseDOM();\r
  57 \r
  58         /**\r
  59           * @see XMLObject::clone()\r
  60           */\r
  61         XMLObject* clone() const;\r
  62 \r
  63         /**\r
  64          * @see XMLObject::hasChildren()\r
  65          */\r
  66         bool hasChildren() const {\r
  67             return false;\r
  68         }\r
  69 \r
  70         /**\r
  71          * @see XMLObject::getOrderedChildren()\r
  72          */\r
  73         size_t getOrderedChildren(std::vector<XMLObject*>& v) const {\r
  74             return 0;\r
  75         }\r
  76 \r
  77     protected:\r
  78         /**\r
  79          * When needed, we can serialize the DOM into XML form and preserve it here.\r
  80          */\r
  81         std::string m_xml;\r
  82 \r
  83     private:\r
  84         void serialize(std::string& s) const;\r
  85         friend class XMLTOOL_API UnknownElementMarshaller;\r
  86     };\r
  87 \r
  88     /**\r
  89      * Factory for UnknownElementImpl objects\r
  90      */\r
  91     class XMLTOOL_DLLLOCAL UnknownElementBuilder : public virtual XMLObjectBuilder\r
  92     {\r
  93     public:\r
  94         UnknownElementBuilder() {}\r
  95         virtual ~UnknownElementBuilder() {}\r
  96     \r
  97         /**\r
  98          * @see XMLObjectBuilder::buildObject()\r
  99          */\r
 100         XMLObject* buildObject() const {\r
 101             return new UnknownElementImpl();\r
 102         }\r
 103     };\r
 104 \r
 105     /**\r
 106      * Marshaller for UnknownElementImpl objects\r
 107      */\r
 108     class XMLTOOL_DLLLOCAL UnknownElementMarshaller : public virtual Marshaller\r
 109     {\r
 110     public:\r
 111         UnknownElementMarshaller() {}\r
 112         virtual ~UnknownElementMarshaller() {}\r
 113     \r
 114         /**\r
 115          * @see Marshaller::marshall(XMLObject*,DOMDocument*)\r
 116          */\r
 117         DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;\r
 118 \r
 119         /**\r
 120          * @see Marshaller::marshall(XMLObject*,DOMElement*)\r
 121          */\r
 122         DOMElement* marshall(XMLObject* xmlObject, DOMElement* parentElement) const;\r
 123         \r
 124     protected:\r
 125         void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
 126             DOMElement* documentRoot = document->getDocumentElement();\r
 127             if (documentRoot)\r
 128                 document->replaceChild(documentRoot, element);\r
 129             else\r
 130                 document->appendChild(element);\r
 131         }\r
 132     };\r
 133 \r
 134     /**\r
 135      * Marshaller for UnknownElementImpl objects\r
 136      */\r
 137     class XMLTOOL_DLLLOCAL UnknownElementUnmarshaller : public virtual Unmarshaller\r
 138     {\r
 139     public:\r
 140         UnknownElementUnmarshaller() {}\r
 141         virtual ~UnknownElementUnmarshaller() {}\r
 142     \r
 143         /**\r
 144          * @see Unmarshaller::unmarshall()\r
 145          */\r
 146         XMLObject* unmarshall(DOMElement* element, bool bindDocument=false) const;\r
 147     };\r
 148 };\r
 149 \r
 150 #if defined (_MSC_VER)\r
 151     #pragma warning( pop )\r
 152 #endif\r
 153 \r
 154 #endif /* __xmltooling_unkelement_h__ */\r