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 implementation suitable for use as default for unrecognized content\r
  21  */\r
  22 \r
  23 #ifndef __xmltooling_unkelement_h__\r
  24 #define __xmltooling_unkelement_h__\r
  25 \r
  26 #include <xmltooling/AbstractChildlessElement.h>\r
  27 #include <xmltooling/exceptions.h>\r
  28 #include <xmltooling/XMLObjectBuilder.h>\r
  29 #include <xmltooling/io/AbstractXMLObjectMarshaller.h>\r
  30 #include <xmltooling/io/AbstractXMLObjectUnmarshaller.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     /// @cond off\r
  42     class XMLTOOL_DLLLOCAL UnknownElementImpl : public AbstractChildlessElement, public AbstractDOMCachingXMLObject\r
  43     {\r
  44     public:\r
  45         UnknownElementImpl(const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL)\r
  46             : AbstractXMLObject(namespaceURI, elementLocalName, namespacePrefix) {}\r
  47     \r
  48         void releaseDOM() const;\r
  49 \r
  50         XMLObject* clone() const;\r
  51 \r
  52         DOMElement* marshall(\r
  53             DOMDocument* document=NULL\r
  54 #ifndef XMLTOOLING_NO_XMLSEC\r
  55             ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
  56 #endif\r
  57             ) const;\r
  58 \r
  59         DOMElement* marshall(\r
  60             DOMElement* parentElement\r
  61 #ifndef XMLTOOLING_NO_XMLSEC\r
  62             ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
  63 #endif\r
  64             ) const;\r
  65         XMLObject* unmarshall(DOMElement* element, bool bindDocument=false);\r
  66         \r
  67     protected:\r
  68         void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
  69             DOMElement* documentRoot = document->getDocumentElement();\r
  70             if (documentRoot)\r
  71                 document->replaceChild(element, documentRoot);\r
  72             else\r
  73                 document->appendChild(element);\r
  74         }\r
  75 \r
  76         mutable std::string m_xml;\r
  77 \r
  78         void serialize(std::string& s) const;\r
  79     };\r
  80     /// @endcond\r
  81     \r
  82     /**\r
  83      * Builder for UnknownElementImpl objects.\r
  84      * Use as the default builder when you want unknown DOM content treated as raw/ignored XML.\r
  85      */\r
  86     class XMLTOOL_API UnknownElementBuilder : public XMLObjectBuilder\r
  87     {\r
  88     public:\r
  89         XMLObject* buildObject(\r
  90             const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL\r
  91             ) const;\r
  92     };\r
  93 \r
  94 };\r
  95 \r
  96 #if defined (_MSC_VER)\r
  97     #pragma warning( pop )\r
  98 #endif\r
  99 \r
 100 #endif /* __xmltooling_unkelement_h__ */\r