2 * Copyright 2001-2006 Internet2
\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
8 * http://www.apache.org/licenses/LICENSE-2.0
\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
18 * @file UnknownElement.h
\r
20 * Basic implementations suitable for use as defaults for unrecognized content
\r
23 #if !defined(__xmltooling_unkelement_h__)
\r
24 #define __xmltooling_unkelement_h__
\r
26 #include "internal.h"
\r
27 #include "AbstractDOMCachingXMLObject.h"
\r
28 #include "XMLObjectBuilder.h"
\r
29 #include "io/Marshaller.h"
\r
30 #include "io/Unmarshaller.h"
\r
34 #if defined (_MSC_VER)
\r
35 #pragma warning( push )
\r
36 #pragma warning( disable : 4250 4251 )
\r
39 namespace xmltooling {
\r
42 * Implementation class for unrecognized DOM elements.
\r
43 * Purpose is to wrap the DOM and do any necessary caching/reconstruction
\r
44 * when a DOM has to cross into a new document.
\r
46 class XMLTOOL_DLLLOCAL UnknownElementImpl : public AbstractDOMCachingXMLObject
\r
49 UnknownElementImpl() {}
\r
50 virtual ~UnknownElementImpl() {}
\r
53 * Overridden to ensure XML content of DOM isn't lost.
\r
55 * @see DOMCachingXMLObject::releaseDOM()
\r
60 * @see XMLObject::clone()
\r
62 XMLObject* clone() const;
\r
65 * @see XMLObject::hasChildren()
\r
67 bool hasChildren() const {
\r
72 * @see XMLObject::getOrderedChildren()
\r
74 size_t getOrderedChildren(std::vector<XMLObject*>& v) const {
\r
80 * When needed, we can serialize the DOM into XML form and preserve it here.
\r
85 void serialize(std::string& s) const;
\r
86 friend class XMLTOOL_API UnknownElementMarshaller;
\r
90 * Factory for UnknownElementImpl objects
\r
92 class XMLTOOL_DLLLOCAL UnknownElementBuilder : public virtual XMLObjectBuilder
\r
95 UnknownElementBuilder() {}
\r
96 virtual ~UnknownElementBuilder() {}
\r
99 * @see XMLObjectBuilder::buildObject()
\r
101 XMLObject* buildObject() const {
\r
102 return new UnknownElementImpl();
\r
107 * Marshaller for UnknownElementImpl objects
\r
109 class XMLTOOL_DLLLOCAL UnknownElementMarshaller : public virtual Marshaller
\r
112 UnknownElementMarshaller() {}
\r
113 virtual ~UnknownElementMarshaller() {}
\r
116 * @see Marshaller::marshall(XMLObject*,DOMDocument*)
\r
118 DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;
\r
121 * @see Marshaller::marshall(XMLObject*,DOMElement*)
\r
123 DOMElement* marshall(XMLObject* xmlObject, DOMElement* parentElement) const;
\r
126 void setDocumentElement(DOMDocument* document, DOMElement* element) const {
\r
127 DOMElement* documentRoot = document->getDocumentElement();
\r
129 document->replaceChild(documentRoot, element);
\r
131 document->appendChild(element);
\r
136 * Marshaller for UnknownElementImpl objects
\r
138 class XMLTOOL_DLLLOCAL UnknownElementUnmarshaller : public virtual Unmarshaller
\r
141 UnknownElementUnmarshaller() {}
\r
142 virtual ~UnknownElementUnmarshaller() {}
\r
145 * @see Unmarshaller::unmarshall()
\r
147 XMLObject* unmarshall(DOMElement* element, bool bindDocument=false) const;
\r
151 #if defined (_MSC_VER)
\r
152 #pragma warning( pop )
\r
155 #endif /* __xmltooling_unkelement_h__ */
\r