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