Added detach() method to strip off a root parent element, fixed bug in namespace...

[shibboleth/cpp-xmltooling.git] / xmltooling / AbstractDOMCachingXMLObject.h

diff --git a/xmltooling/AbstractDOMCachingXMLObject.h b/xmltooling/AbstractDOMCachingXMLObject.h
index 3959b22..1e357b9 100644 (file)
--- a/xmltooling/AbstractDOMCachingXMLObject.h
+++ b/xmltooling/AbstractDOMCachingXMLObject.h
@@ -17,14 +17,13 @@
 /**\r
  * @file AbstractDOMCachingXMLObject.h\r
  * \r
- * Extension of AbstractXMLObject that implements a DOMCachingXMLObject. \r
+ * AbstractXMLObject mixin that implements DOM caching\r
  */\r
 \r
 #if !defined(__xmltooling_abstractdomxmlobj_h__)\r
 #define __xmltooling_abstractdomxmlobj_h__\r
 \r
 #include <xmltooling/AbstractXMLObject.h>\r
-#include <xmltooling/DOMCachingXMLObject.h>\r
 \r
 #if defined (_MSC_VER)\r
     #pragma warning( push )\r
@@ -34,118 +33,54 @@
 namespace xmltooling {\r
 \r
     /**\r
-     * Extension of AbstractXMLObject that implements a DOMCachingXMLObject.\r
+     * AbstractXMLObject mixin that implements DOM caching.\r
+     * Inherit from this class to implement standard DOM caching behavior.\r
      */\r
-    class XMLTOOL_API AbstractDOMCachingXMLObject : public virtual AbstractXMLObject, public virtual DOMCachingXMLObject\r
+    class XMLTOOL_API AbstractDOMCachingXMLObject : public virtual AbstractXMLObject\r
     {\r
     public:\r
         virtual ~AbstractDOMCachingXMLObject();\r
         \r
-        /**\r
-         * @see DOMCachingXMLObject::getDOM()\r
-         */\r
-        const DOMElement* getDOM() const {\r
+        DOMElement* getDOM() const {\r
             return m_dom;\r
         }\r
         \r
-        /**\r
-         * @see DOMCachingXMLObject::setDOM()\r
-         */\r
-        void setDOM(DOMElement* dom) {\r
-            m_dom=dom;\r
-        }\r
+        void setDOM(DOMElement* dom, bool bindDocument=false) const;\r
         \r
-        /**\r
-         * @see DOMCachingXMLObject::setDocument()\r
-         */\r
-        DOMDocument* setDocument(DOMDocument* doc) {\r
-            DOMDocument* ret=m_document;\r
+        void setDocument(DOMDocument* doc) const {\r
+            if (m_document)\r
+                m_document->release();\r
             m_document=doc;\r
-            return ret;\r
         }\r
     \r
-        /**\r
-         * @see DOMCachingXMLObject::releaseDOM()\r
-         */\r
-        void releaseDOM();\r
+        virtual void releaseDOM() const;\r
         \r
-        /**\r
-         * @see DOMCachingXMLObject::releaseParentDOM()\r
-         */\r
-        void releaseParentDOM(bool propagateRelease=true);\r
+        virtual void releaseParentDOM(bool propagateRelease=true) const;\r
         \r
-        /**\r
-         * @see DOMCachingXMLObject::releaseChildrenDOM()\r
-         */\r
-        void releaseChildrenDOM(bool propagateRelease=true);\r
-    \r
-        /**\r
-         * A convenience method that is equal to calling releaseDOM() then releaseParentDOM(true).\r
-         */\r
-        void releaseThisandParentDOM() {\r
-            if (m_dom) {\r
-                releaseDOM();\r
-                releaseParentDOM(true);\r
-            }\r
-        }\r
-    \r
-        /**\r
-         * A convenience method that is equal to calling releaseDOM() then releaseChildrenDOM(true).\r
-         */\r
-        void releaseThisAndChildrenDOM() {\r
-            if (m_dom) {\r
-                releaseDOM();\r
-                releaseChildrenDOM(true);\r
-            }\r
-        }\r
+        virtual void releaseChildrenDOM(bool propagateRelease=true) const;\r
     \r
+        XMLObject* clone() const;\r
+\r
+        void detach();\r
+\r
      protected:\r
-        /**\r
-         * A helper function for derived classes.\r
-         * This 'normalizes' newString and then if it is different from oldString\r
-         * invalidates the DOM. It returns the normalized value.\r
-         * \r
-         * @param oldValue - the current value\r
-         * @param newValue - the new value\r
-         * \r
-         * @return the value that should be assigned\r
-         */\r
-        XMLCh* prepareForAssignment(const XMLCh* oldValue, const XMLCh* newValue) {\r
-            XMLCh* newString = XMLString::replicate(newValue);\r
-            XMLString::trim(newString);\r
+        AbstractDOMCachingXMLObject() : m_dom(NULL), m_document(NULL) {}\r
 \r
-            if (oldValue && !newValue || !oldValue && newValue || XMLString::compareString(oldValue,newValue))\r
-                releaseThisandParentDOM();\r
-    \r
-            return newString;\r
-        }\r
-    \r
-        /**\r
-         * A helper function for derived classes, for assignment of (singleton) XML objects.\r
-         * \r
-         * It is indifferent to whether either the old or the new version of the value is null. \r
-         * This method will do a safe compare of the objects and will also invalidate the DOM if appropriate\r
-         * \r
-         * @param oldValue - current value\r
-         * @param newValue - proposed new value\r
-         * @return The value to assign to the saved Object.\r
-         * \r
-         * @throws IllegalArgumentException if the child already has a parent.\r
-         */\r
-        XMLObject* prepareForAssignment(const XMLObject* oldValue, XMLObject* newValue);\r
+        /** Copy constructor. */\r
+        AbstractDOMCachingXMLObject(const AbstractDOMCachingXMLObject& src)\r
+            : AbstractXMLObject(src), m_dom(NULL), m_document(NULL) {}\r
 \r
         /**\r
-         * Constructor\r
+         * If a DOM representation exists, this clones it into a new document.\r
          * \r
-         * @param namespaceURI the namespace the element is in\r
-         * @param elementLocalName the local name of the XML element this Object represents\r
+         * @param doc   the document to clone into, or NULL, in which case a new document is created\r
+         * @return  the cloned DOM\r
          */\r
-        explicit AbstractDOMCachingXMLObject(const XMLCh* namespaceURI, const XMLCh* elementLocalName)\r
-            : AbstractXMLObject(namespaceURI,elementLocalName), m_dom(NULL), m_document(NULL) {}\r
+        DOMElement* cloneDOM(DOMDocument* doc=NULL) const;\r
 \r
     private:\r
-        DOMElement* m_dom;\r
-        DOMDocument* m_document;\r
+        mutable DOMElement* m_dom;\r
+        mutable DOMDocument* m_document;\r
     };\r
     \r
 };\r