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         virtual ~UnknownElementImpl() {}\r
  51 \r
  52         /**\r
  53          * Overridden to ensure XML content of DOM isn't lost.\r
  54          * \r
  55          * @see DOMCachingXMLObject::releaseDOM()\r
  56          */\r
  57         void releaseDOM();\r
  58 \r
  59         /**\r
  60           * @see XMLObject::clone()\r
  61           */\r
  62         XMLObject* clone() const;\r
  63 \r
  64         /**\r
  65          * @see XMLObject::hasChildren()\r
  66          */\r
  67         bool hasChildren() const {\r
  68             return false;\r
  69         }\r
  70 \r
  71         /**\r
  72          * @see XMLObject::getOrderedChildren()\r
  73          */\r
  74         size_t getOrderedChildren(std::vector<XMLObject*>& v) const {\r
  75             return 0;\r
  76         }\r
  77 \r
  78     protected:\r
  79         /**\r
  80          * When needed, we can serialize the DOM into XML form and preserve it here.\r
  81          */\r
  82         std::string m_xml;\r
  83 \r
  84     private:\r
  85         void serialize(std::string& s) const;\r
  86         friend class XMLTOOL_API UnknownElementMarshaller;\r
  87     };\r
  88 \r
  89     /**\r
  90      * Factory for UnknownElementImpl objects\r
  91      */\r
  92     class XMLTOOL_DLLLOCAL UnknownElementBuilder : public virtual XMLObjectBuilder\r
  93     {\r
  94     public:\r
  95         UnknownElementBuilder() {}\r
  96         virtual ~UnknownElementBuilder() {}\r
  97     \r
  98         /**\r
  99          * @see XMLObjectBuilder::buildObject()\r
 100          */\r
 101         XMLObject* buildObject() const {\r
 102             return new UnknownElementImpl();\r
 103         }\r
 104     };\r
 105 \r
 106     /**\r
 107      * Marshaller for UnknownElementImpl objects\r
 108      */\r
 109     class XMLTOOL_DLLLOCAL UnknownElementMarshaller : public virtual Marshaller\r
 110     {\r
 111     public:\r
 112         UnknownElementMarshaller() {}\r
 113         virtual ~UnknownElementMarshaller() {}\r
 114     \r
 115         /**\r
 116          * @see Marshaller::marshall(XMLObject*,DOMDocument*)\r
 117          */\r
 118         DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;\r
 119 \r
 120         /**\r
 121          * @see Marshaller::marshall(XMLObject*,DOMElement*)\r
 122          */\r
 123         DOMElement* marshall(XMLObject* xmlObject, DOMElement* parentElement) const;\r
 124         \r
 125     protected:\r
 126         void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
 127             DOMElement* documentRoot = document->getDocumentElement();\r
 128             if (documentRoot)\r
 129                 document->replaceChild(documentRoot, element);\r
 130             else\r
 131                 document->appendChild(element);\r
 132         }\r
 133     };\r
 134 \r
 135     /**\r
 136      * Marshaller for UnknownElementImpl objects\r
 137      */\r
 138     class XMLTOOL_DLLLOCAL UnknownElementUnmarshaller : public virtual Unmarshaller\r
 139     {\r
 140     public:\r
 141         UnknownElementUnmarshaller() {}\r
 142         virtual ~UnknownElementUnmarshaller() {}\r
 143     \r
 144         /**\r
 145          * @see Unmarshaller::unmarshall()\r
 146          */\r
 147         XMLObject* unmarshall(DOMElement* element, bool bindDocument=false) const;\r
 148     };\r
 149 };\r
 150 \r
 151 #if defined (_MSC_VER)\r
 152     #pragma warning( pop )\r
 153 #endif\r
 154 \r
 155 #endif /* __xmltooling_unkelement_h__ */\r