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
20 * Abstract interface to objects that can be manipulated in and out of XML form.
\r
23 #ifndef __xmltooling_xmlobj_h__
\r
24 #define __xmltooling_xmlobj_h__
\r
29 #include <xercesc/dom/DOM.hpp>
\r
30 #include <xmltooling/QName.h>
\r
31 #include <xmltooling/Namespace.h>
\r
33 using namespace xercesc;
\r
35 #ifndef XMLTOOLING_NO_XMLSEC
\r
36 namespace xmlsignature {
\r
37 class XMLTOOL_API Signature;
\r
41 #if defined (_MSC_VER)
\r
42 #pragma warning( push )
\r
43 #pragma warning( disable : 4250 4251 )
\r
46 namespace xmltooling {
\r
49 * Object that represents an XML Element that has been unmarshalled into this C++ object.
\r
51 class XMLTOOL_API XMLObject
\r
54 virtual ~XMLObject() {}
\r
57 * Creates a copy of the object, along with all of its children.
\r
59 * The new object tree will be completely distinct and independent of
\r
60 * the original in all respects.
\r
62 virtual XMLObject* clone() const=0;
\r
65 * Specialized function for detaching a child object from its parent
\r
66 * <strong>while disposing of the parent</strong>.
\r
68 * This is not a generic way of detaching any child object, but only of
\r
69 * pruning a single child from the root of an XMLObject tree. If the
\r
70 * detached XMLObject's parent is itself a child, an exception will be
\r
71 * thrown. It's mainly useful for turning a child into the new root of
\r
72 * the tree without having to clone the child.
\r
74 virtual void detach()=0;
\r
77 * Gets the QName for this element. This QName <strong>MUST</strong>
\r
78 * contain the namespace URI, namespace prefix, and local element name.
\r
80 * @return constant reference to the QName for this object
\r
82 virtual const QName& getElementQName() const=0;
\r
85 * Gets the namespaces that are scoped to this element.
\r
87 * The caller MUST NOT modify the set returned, but may use any
\r
88 * non-modifying operations or algorithms on it. Iterators will
\r
89 * remain valid unless the set member referenced is removed using
\r
90 * the removeNamespace method.
\r
92 * @return the namespaces that are scoped to this element
\r
94 virtual const std::set<Namespace>& getNamespaces() const=0;
\r
97 * Adds a namespace to the ones already scoped to this element
\r
99 * @param ns the namespace to add
\r
101 virtual void addNamespace(const Namespace& ns) const=0;
\r
104 * Removes a namespace from this element
\r
106 * @param ns the namespace to remove
\r
108 virtual void removeNamespace(const Namespace& ns)=0;
\r
111 * Gets the XML schema type of this element. This translates to contents the xsi:type
\r
112 * attribute for the element.
\r
114 * @return XML schema type of this element
\r
116 virtual const QName* getSchemaType() const=0;
\r
119 * Gets the value of the ID attribute set on this object, if any.
\r
121 * @return an ID value or NULL
\r
123 virtual const XMLCh* getXMLID() const=0;
\r
126 * Checks to see if this object has a parent.
\r
128 * @return true if the object has a parent, false if not
\r
130 virtual bool hasParent() const=0;
\r
133 * Gets the parent of this element or null if there is no parent.
\r
135 * @return the parent of this element or null
\r
137 virtual XMLObject* getParent() const=0;
\r
140 * Sets the parent of this element.
\r
142 * @param parent the parent of this element
\r
144 virtual void setParent(XMLObject* parent)=0;
\r
147 * Checks if this XMLObject has children.
\r
149 * @return true if this XMLObject has children, false if not
\r
151 virtual bool hasChildren() const=0;
\r
154 * Returns an unmodifiable list of child objects in the order that they
\r
155 * should appear in the serialized representation.
\r
157 * The validity of the returned list is not maintained if any non-const
\r
158 * operations are performed on the parent object.
\r
160 * @return the list of children
\r
162 virtual const std::list<XMLObject*>& getOrderedChildren() const=0;
\r
165 * Used by a child's detach method to isolate the child from
\r
166 * this parent object in preparation for destroying the parent
\r
169 * @param child the child object to remove
\r
171 virtual void removeChild(XMLObject* child)=0;
\r
174 * Returns the text content at the specified position relative to
\r
175 * any child elements. A zero represents leading text, 1 comes after
\r
176 * the first child, and so forth.
\r
178 * @param position the relative child element position of the text
\r
179 * @return the designated text value
\r
181 virtual const XMLCh* getTextContent(unsigned int position=0) const=0;
\r
184 * Sets (or clears) text content relative to a child element's position.
\r
186 * @param value value to set, or NULL to clear
\r
187 * @param position position relative to child element
\r
189 virtual void setTextContent(const XMLCh* value, unsigned int position=0)=0;
\r
192 * Gets the DOM representation of this XMLObject, if one exists.
\r
194 * @return the DOM representation of this XMLObject
\r
196 virtual DOMElement* getDOM() const=0;
\r
199 * Sets the DOM representation of this XMLObject.
\r
201 * @param dom DOM representation of this XMLObject
\r
202 * @param bindDocument true if the object should take ownership of the associated Document
\r
204 virtual void setDOM(DOMElement* dom, bool bindDocument=false) const=0;
\r
207 * Assigns ownership of a DOM document to the XMLObject.
\r
208 * This binds the lifetime of the document to the lifetime of the object.
\r
210 * @param doc DOM document bound to this object
\r
212 virtual void setDocument(DOMDocument* doc) const=0;
\r
215 * Releases the DOM representation of this XMLObject, if there is one.
\r
217 virtual void releaseDOM() const=0;
\r
220 * Releases the DOM representation of this XMLObject's parent.
\r
222 * @param propagateRelease true if all ancestors of this element should release their DOM
\r
224 virtual void releaseParentDOM(bool propagateRelease=true) const=0;
\r
227 * Releases the DOM representation of this XMLObject's children.
\r
229 * @param propagateRelease true if all descendants of this element should release their DOM
\r
231 virtual void releaseChildrenDOM(bool propagateRelease=true) const=0;
\r
234 * A convenience method that is equal to calling releaseDOM() then releaseParentDOM(true).
\r
236 void releaseThisandParentDOM() const {
\r
239 releaseParentDOM(true);
\r
244 * A convenience method that is equal to calling releaseChildrenDOM(true) then releaseDOM().
\r
246 void releaseThisAndChildrenDOM() const {
\r
248 releaseChildrenDOM(true);
\r
254 * Marshalls the XMLObject, and its children, into a DOM element.
\r
255 * If a document is supplied, then it will be used to create the resulting elements.
\r
256 * If the document does not have a Document Element set, then the resulting
\r
257 * element will be set as the Document Element. If no document is supplied, then
\r
258 * a new document will be created and bound to the lifetime of the root object being
\r
259 * marshalled, unless an existing DOM can be reused without creating a new document.
\r
261 * @param document the DOM document the marshalled element will be placed in, or NULL
\r
262 * @param sigs ordered array of signatures to create after marshalling is complete
\r
263 * @return the DOM element representing this XMLObject
\r
265 * @throws MarshallingException thrown if there is a problem marshalling the given object
\r
266 * @throws SignatureException thrown if a problem occurs during signature creation
\r
268 virtual DOMElement* marshall(
\r
269 DOMDocument* document=NULL
\r
270 #ifndef XMLTOOLING_NO_XMLSEC
\r
271 ,const std::vector<xmlsignature::Signature*>* sigs=NULL
\r
276 * Marshalls the XMLObject and appends it as a child of the given parent element.
\r
278 * <strong>NOTE:</strong> The given Element must be within a DOM tree rooted in
\r
279 * the Document owning the given Element.
\r
281 * @param parentElement the parent element to append the resulting DOM tree
\r
282 * @param sigs ordered array of signatures to create after marshalling is complete
\r
283 * @return the marshalled element tree
\r
285 * @throws MarshallingException thrown if the given XMLObject can not be marshalled.
\r
286 * @throws SignatureException thrown if a problem occurs during signature creation
\r
288 virtual DOMElement* marshall(
\r
289 DOMElement* parentElement
\r
290 #ifndef XMLTOOLING_NO_XMLSEC
\r
291 ,const std::vector<xmlsignature::Signature*>* sigs=NULL
\r
296 * Unmarshalls the given W3C DOM element into the XMLObject.
\r
297 * The root of a given XML construct should be unmarshalled with the bindDocument parameter
\r
300 * @param element the DOM element to unmarshall
\r
301 * @param bindDocument true iff the resulting XMLObject should take ownership of the DOM's Document
\r
303 * @return the unmarshalled XMLObject
\r
305 * @throws UnmarshallingException thrown if an error occurs unmarshalling the DOM element into the XMLObject
\r
307 virtual XMLObject* unmarshall(DOMElement* element, bool bindDocument=false)=0;
\r
312 XMLObject& operator=(const XMLObject& src);
\r
315 #if defined (_MSC_VER)
\r
316 #pragma warning( pop )
\r
321 #endif /* __xmltooling_xmlobj_h__ */
\r