xmltooling/DOMCachingXMLObject.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 DOMCachingXMLObject.h\r
  19  * \r
  20  * An XMLObject that can cached a DOM representation of itself. \r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_domxmlobj_h__)\r
  24 #define __xmltooling_domxmlobj_h__\r
  25 \r
  26 #include <xercesc/dom/DOM.hpp>\r
  27 #include <xmltooling/XMLObject.h>\r
  28 \r
  29 using namespace xercesc;\r
  30 \r
  31 namespace xmltooling {\r
  32 \r
  33     /**\r
  34      * An XMLObject that can cached a DOM representation of itself.\r
  35      */\r
  36     class XMLTOOL_API DOMCachingXMLObject : public virtual XMLObject\r
  37     {\r
  38     public:\r
  39         DOMCachingXMLObject() {}\r
  40         virtual ~DOMCachingXMLObject() {}\r
  41         \r
  42         /**\r
  43          * Gets the DOM representation of this XMLObject, if one exists.\r
  44          * \r
  45          * @return the DOM representation of this XMLObject\r
  46          */\r
  47         virtual DOMElement* getDOM() const=0;\r
  48         \r
  49         /**\r
  50          * Sets the DOM representation of this XMLObject.\r
  51          * \r
  52          * @param dom       DOM representation of this XMLObject\r
  53          * @param bindDocument  true if the object should take ownership of the associated Document\r
  54          */\r
  55         virtual void setDOM(DOMElement* dom, bool bindDocument=false) const=0;\r
  56     \r
  57         /**\r
  58          * Assigns ownership of a DOM document to the XMLObject.\r
  59          * This binds the lifetime of the document to the lifetime of the object.\r
  60          * \r
  61          * @param doc DOM document bound to this object \r
  62          */\r
  63         virtual void setDocument(DOMDocument* doc) const=0;\r
  64 \r
  65         /**\r
  66          * Releases the DOM representation of this XMLObject, if there is one.\r
  67          */\r
  68         virtual void releaseDOM() const=0;\r
  69         \r
  70         /**\r
  71          * Releases the DOM representation of this XMLObject's parent.\r
  72          * \r
  73          * @param propagateRelease true if all ancestors of this element should release their DOM\r
  74          */\r
  75         virtual void releaseParentDOM(bool propagateRelease=true) const=0;\r
  76         \r
  77         /**\r
  78          * Releases the DOM representation of this XMLObject's children.\r
  79          * \r
  80          * @param propagateRelease true if all descendants of this element should release their DOM\r
  81          */\r
  82         virtual void releaseChildrenDOM(bool propagateRelease=true) const=0;\r
  83     };\r
  84     \r
  85 };\r
  86 \r
  87 #endif /* __xmltooling_domxmlobj_h__ */\r