Initial DOM handling interfaces.
[shibboleth/cpp-xmltooling.git] / xmltooling / AbstractDOMCachingXMLObject.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  * AbstractDOMCachingXMLObject.cpp\r
19  * \r
20  * Extension of AbstractXMLObject that implements a DOMCachingXMLObject. \r
21  */\r
22 \r
23 #include "internal.h"\r
24 #include "exceptions.h"\r
25 #include "AbstractDOMCachingXMLObject.h"\r
26 \r
27 #include <algorithm>\r
28 #include <functional>\r
29 #include <log4cpp/Category.hh>\r
30 \r
31 using namespace xmltooling;\r
32 using namespace log4cpp;\r
33 using namespace std;\r
34 \r
35 AbstractDOMCachingXMLObject::~AbstractDOMCachingXMLObject()\r
36 {\r
37     if (m_document)\r
38         m_document->release();\r
39 }\r
40 \r
41 void AbstractDOMCachingXMLObject::releaseDOM()\r
42 {\r
43     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
44     if (log.isDebugEnabled())\r
45         log.debug("Releasing cached DOM reprsentation for %s", getElementQName().toString().c_str());\r
46 \r
47     // We don't get rid of the document we're holding, if any.\r
48     // The marshalling process deals with that.\r
49     setDOM(NULL);\r
50 }\r
51 \r
52 void AbstractDOMCachingXMLObject::releaseParentDOM(bool propagateRelease)\r
53 {\r
54     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
55     if (log.isDebugEnabled()) {\r
56         log.debug(\r
57             "Releasing cached DOM representation for parent of %s with propagation set to %s",\r
58             getElementQName().toString().c_str(), propagateRelease ? "true" : "false"\r
59             );\r
60     }\r
61 \r
62     DOMCachingXMLObject* domCachingParent = dynamic_cast<DOMCachingXMLObject*>(getParent());\r
63     if (domCachingParent) {\r
64         domCachingParent->releaseDOM();\r
65         if (propagateRelease)\r
66             domCachingParent->releaseParentDOM(propagateRelease);\r
67     }\r
68 }\r
69 \r
70 class _release : public binary_function<XMLObject*,bool,void> {\r
71 public:\r
72     void operator()(XMLObject* obj, bool propagate) const {\r
73         DOMCachingXMLObject* domCachingParent = dynamic_cast<DOMCachingXMLObject*>(obj);\r
74         if (domCachingParent) {\r
75             domCachingParent->releaseDOM();\r
76             if (propagate)\r
77                 domCachingParent->releaseChildrenDOM(propagate);\r
78         }\r
79     }\r
80 };\r
81 \r
82 void AbstractDOMCachingXMLObject::releaseChildrenDOM(bool propagateRelease)\r
83 {\r
84     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
85     if (log.isDebugEnabled()) {\r
86         log.debug(\r
87             "Releasing cached DOM representation for children of %s with propagation set to %s",\r
88             getElementQName().toString().c_str(), propagateRelease ? "true" : "false"\r
89             );\r
90     }\r
91     \r
92     vector<XMLObject*> children;\r
93     if (getOrderedChildren(children))\r
94         for_each(children.begin(),children.end(),bind2nd(_release(),propagateRelease));\r
95 }\r
96 \r
97 XMLObject* AbstractDOMCachingXMLObject::prepareForAssignment(const XMLObject* oldValue, XMLObject* newValue) {\r
98 \r
99     if (newValue && newValue->hasParent())\r
100         throw XMLObjectException("child XMLObject cannot be added - it is already the child of another XMLObject");\r
101 \r
102     if (!oldValue) {\r
103         if (newValue) {\r
104             releaseThisandParentDOM();\r
105             newValue->setParent(this);\r
106             return newValue;\r
107         }\r
108         else {\r
109             return NULL;\r
110         }\r
111     }\r
112 \r
113     if (oldValue != newValue) {\r
114         delete oldValue;\r
115         releaseThisandParentDOM();\r
116         newValue->setParent(this);\r
117     }\r
118 \r
119     return newValue;\r
120 }\r