xmltooling/impl/UnknownElement.cpp

   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  * UnknownElement.cpp\r
  19  * \r
  20  * Basic implementations suitable for use as defaults for unrecognized content\r
  21  */\r
  22 \r
  23 #include "internal.h"\r
  24 #include "exceptions.h"\r
  25 #include "impl/UnknownElement.h"\r
  26 #include "util/NDC.h"\r
  27 #include "util/XMLHelper.h"\r
  28 \r
  29 #include <log4cpp/Category.hh>\r
  30 #include <xercesc/framework/MemBufInputSource.hpp>\r
  31 #include <xercesc/framework/Wrapper4InputSource.hpp>\r
  32 #include <xercesc/util/XMLUniDefs.hpp>\r
  33 \r
  34 using namespace xmltooling;\r
  35 using namespace log4cpp;\r
  36 using namespace std;\r
  37 \r
  38 void UnknownElementImpl::releaseDOM()\r
  39 {\r
  40 #ifdef _DEBUG\r
  41     xmltooling::NDC ndc("releaseDOM");\r
  42 #endif\r
  43     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".UnknownElementImpl");\r
  44     log.debug("releasing DOM for unknown content, preserving current DOM in XML form");\r
  45 \r
  46     // We're losing our DOM, so assuming we have one, we preserve it.\r
  47     serialize(m_xml);\r
  48 \r
  49     // This takes care of the generic housekeeping now that we've preserved things.\r
  50     AbstractDOMCachingXMLObject::releaseDOM();\r
  51 }\r
  52 \r
  53 XMLObject* UnknownElementImpl::clone() const\r
  54 {\r
  55     UnknownElementImpl* ret=new UnknownElementImpl();\r
  56 \r
  57     // If there's no XML locally, serialize this object into the new one.\r
  58     // Otherwise just copy it over.\r
  59     if (m_xml.empty())\r
  60         serialize(ret->m_xml);\r
  61     else\r
  62         ret->m_xml=m_xml;\r
  63 \r
  64     return ret;\r
  65 }\r
  66 \r
  67 void UnknownElementImpl::serialize(string& s) const\r
  68 {\r
  69     if (getDOM())\r
  70         XMLHelper::serialize(getDOM(),s);\r
  71 }\r
  72 \r
  73 DOMElement* UnknownElementMarshaller::marshall(XMLObject* xmlObject, DOMDocument* document) const\r
  74 {\r
  75 #ifdef _DEBUG\r
  76     xmltooling::NDC ndc("marshall");\r
  77 #endif\r
  78     \r
  79     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".Marshaller");\r
  80     log.debug("marshalling unknown content");\r
  81 \r
  82     UnknownElementImpl* unk=dynamic_cast<UnknownElementImpl*>(xmlObject);\r
  83     if (!unk)\r
  84         throw MarshallingException("Only objects of class UnknownElementImpl can be marshalled.");\r
  85     \r
  86     DOMElement* cachedDOM=unk->getDOM();\r
  87     if (cachedDOM) {\r
  88         if (!document || document==cachedDOM->getOwnerDocument()) {\r
  89             log.debug("XMLObject has a usable cached DOM, reusing it");\r
  90             if (document)\r
  91                 setDocumentElement(cachedDOM->getOwnerDocument(),cachedDOM);\r
  92             unk->releaseParentDOM(true);\r
  93             return cachedDOM;\r
  94         }\r
  95         \r
  96         // We have a DOM but it doesn't match the document we were given. This both sucks and blows.\r
  97         // Without an adoptNode option to maintain the child pointers, we rely on our custom\r
  98         // implementation class to preserve the XML when we release the existing DOM.\r
  99         unk->releaseDOM();\r
 100     }\r
 101     \r
 102     // If we get here, we didn't have a usable DOM (and/or we flushed the one we had).\r
 103     // We need to reparse the XML we saved off into a new DOM.\r
 104     bool bindDocument=false;\r
 105     MemBufInputSource src(reinterpret_cast<const XMLByte*>(unk->m_xml.c_str()),unk->m_xml.length(),"UnknownElementImpl");\r
 106     Wrapper4InputSource dsrc(&src,false);\r
 107     log.debug("parsing XML back into DOM tree");\r
 108     DOMDocument* internalDoc=XMLToolingInternalConfig::getInternalConfig().m_parserPool->parse(dsrc);\r
 109     if (document) {\r
 110         // The caller insists on using his own document, so we now have to import the thing\r
 111         // into it. Then we're just dumping the one we built.\r
 112         log.debug("reimporting new DOM into caller-supplied document");\r
 113         cachedDOM=static_cast<DOMElement*>(document->importNode(internalDoc->getDocumentElement(), true));\r
 114         internalDoc->release();\r
 115     }\r
 116     else {\r
 117         // We just bind the document we built to the object as the result.\r
 118         cachedDOM=static_cast<DOMElement*>(internalDoc->getDocumentElement());\r
 119         document=internalDoc;\r
 120         bindDocument=true;\r
 121     }\r
 122 \r
 123     // Recache the DOM and clear the serialized copy.\r
 124     setDocumentElement(document, cachedDOM);\r
 125     log.debug("caching DOM for XMLObject (document is %sbound)", bindDocument ? "" : "not ");\r
 126     unk->setDOM(cachedDOM, bindDocument);\r
 127     unk->releaseParentDOM(true);\r
 128     unk->m_xml.erase();\r
 129     return cachedDOM;\r
 130 }\r
 131 \r
 132 DOMElement* UnknownElementMarshaller::marshall(XMLObject* xmlObject, DOMElement* parentElement) const\r
 133 {\r
 134 #ifdef _DEBUG\r
 135     xmltooling::NDC ndc("marshall");\r
 136 #endif\r
 137     \r
 138     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".Marshaller");\r
 139     log.debug("marshalling unknown content");\r
 140 \r
 141     UnknownElementImpl* unk=dynamic_cast<UnknownElementImpl*>(xmlObject);\r
 142     if (!unk)\r
 143         throw MarshallingException("Only objects of class UnknownElementImpl can be marshalled.");\r
 144     \r
 145     DOMElement* cachedDOM=unk->getDOM();\r
 146     if (cachedDOM) {\r
 147         if (parentElement->getOwnerDocument()==cachedDOM->getOwnerDocument()) {\r
 148             log.debug("XMLObject has a usable cached DOM, reusing it");\r
 149             parentElement->appendChild(cachedDOM);\r
 150             unk->releaseParentDOM(true);\r
 151             return cachedDOM;\r
 152         }\r
 153         \r
 154         // We have a DOM but it doesn't match the document we were given. This both sucks and blows.\r
 155         // Without an adoptNode option to maintain the child pointers, we rely on our custom\r
 156         // implementation class to preserve the XML when we release the existing DOM.\r
 157         unk->releaseDOM();\r
 158     }\r
 159     \r
 160     // If we get here, we didn't have a usable DOM (and/or we flushed the one we had).\r
 161     // We need to reparse the XML we saved off into a new DOM.\r
 162     MemBufInputSource src(reinterpret_cast<const XMLByte*>(unk->m_xml.c_str()),unk->m_xml.length(),"UnknownElementImpl");\r
 163     Wrapper4InputSource dsrc(&src,false);\r
 164     log.debug("parsing XML back into DOM tree");\r
 165     DOMDocument* internalDoc=XMLToolingInternalConfig::getInternalConfig().m_parserPool->parse(dsrc);\r
 166     \r
 167     log.debug("reimporting new DOM into caller-supplied document");\r
 168     cachedDOM=static_cast<DOMElement*>(parentElement->getOwnerDocument()->importNode(internalDoc->getDocumentElement(), true));\r
 169     internalDoc->release();\r
 170 \r
 171     // Recache the DOM and clear the serialized copy.\r
 172     parentElement->appendChild(cachedDOM);\r
 173     log.debug("caching DOM for XMLObject");\r
 174     unk->setDOM(cachedDOM, false);\r
 175     unk->releaseParentDOM(true);\r
 176     unk->m_xml.erase();\r
 177     return cachedDOM;\r
 178 }\r
 179 \r
 180 XMLObject* UnknownElementUnmarshaller::unmarshall(DOMElement* element, bool bindDocument) const\r
 181 {\r
 182     UnknownElementImpl* ret=new UnknownElementImpl();\r
 183     ret->setDOM(element, bindDocument);\r
 184     return ret;\r
 185 }\r