2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * @file xmltooling/AbstractDOMCachingXMLObject.h
24 * AbstractXMLObject mixin that implements DOM caching.
27 #ifndef __xmltooling_abstractdomxmlobj_h__
28 #define __xmltooling_abstractdomxmlobj_h__
30 #include <xmltooling/AbstractXMLObject.h>
32 #if defined (_MSC_VER)
33 #pragma warning( push )
34 #pragma warning( disable : 4250 4251 )
37 namespace xmltooling {
40 * AbstractXMLObject mixin that implements DOM caching.
41 * Inherit from this class to implement standard DOM caching behavior.
43 class XMLTOOL_API AbstractDOMCachingXMLObject : public virtual AbstractXMLObject
46 virtual ~AbstractDOMCachingXMLObject();
48 // Virtual function overrides.
49 xercesc::DOMElement* getDOM() const;
50 void setDOM(xercesc::DOMElement* dom, bool bindDocument=false) const;
51 void setDocument(xercesc::DOMDocument* doc) const;
52 void releaseDOM() const;
53 void releaseParentDOM(bool propagateRelease=true) const;
54 void releaseChildrenDOM(bool propagateRelease=true) const;
55 XMLObject* clone() const;
59 AbstractDOMCachingXMLObject();
61 /** Copy constructor. */
62 AbstractDOMCachingXMLObject(const AbstractDOMCachingXMLObject& src);
65 * If a DOM representation exists, this clones it into a new document.
67 * @param doc the document to clone into, or nullptr, in which case a new document is created
68 * @return the cloned DOM
70 xercesc::DOMElement* cloneDOM(xercesc::DOMDocument* doc=nullptr) const;
73 mutable xercesc::DOMElement* m_dom;
74 mutable xercesc::DOMDocument* m_document;
79 #if defined (_MSC_VER)
80 #pragma warning( pop )
83 #endif /* __xmltooling_abstractdomxmlobj_h__ */