2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file xmltooling/util/XMLHelper.h
20 * A helper class for working with W3C DOM objects.
23 #ifndef __xmltooling_xmlhelper_h__
24 #define __xmltooling_xmlhelper_h__
26 #include <xmltooling/XMLObject.h>
27 #include <xercesc/dom/DOM.hpp>
31 namespace xmltooling {
34 * RAII wrapper for Xerces resources.
36 template<class T> class XercesJanitor
38 MAKE_NONCOPYABLE(XercesJanitor);
44 * @param resource object to release when leaving scope
46 XercesJanitor(T* resource) : m_held(resource) {}
54 * Returns resource held by this object.
56 * @return the resource held or NULL
63 * Returns resource held by this object.
65 * @return the resource held or NULL
72 * Returns resource held by this object and releases it to the caller.
74 * @return the resource held or NULL
84 * A helper class for working with W3C DOM objects.
86 class XMLTOOL_API XMLHelper
90 * Checks if the given element has an xsi:type defined for it
92 * @param e the DOM element
93 * @return true if there is a type, false if not
95 static bool hasXSIType(const xercesc::DOMElement* e);
98 * Gets the XSI type for a given element if it has one.
100 * @param e the element
101 * @return the type or null
103 static QName* getXSIType(const xercesc::DOMElement* e);
106 * Gets the ID attribute of a DOM element.
108 * @param domElement the DOM element
109 * @return the ID attribute or null if there isn't one
111 static xercesc::DOMAttr* getIdAttribute(const xercesc::DOMElement* domElement);
114 * Attempts to locate an XMLObject from this point downward in the tree whose
115 * XML ID matches the supplied value.
117 * @param tree root of tree to search
118 * @param id ID value to locate
119 * @return XMLObject in the tree with a matching ID value, or NULL
121 static const XMLObject* getXMLObjectById(const XMLObject& tree, const XMLCh* id);
125 * Gets the QName for the given DOM node.
127 * @param domNode the DOM node
128 * @return the QName for the element or null if the element was null
130 static QName* getNodeQName(const xercesc::DOMNode* domNode);
133 * Constructs a QName from an attribute's value.
135 * @param attribute the attribute with a QName value
136 * @return a QName from an attribute's value, or null if the given attribute is null
138 static QName* getAttributeValueAsQName(const xercesc::DOMAttr* attribute);
141 * Appends the child Element to the parent Element,
142 * importing the child Element into the parent's Document if needed.
144 * @param parentElement the parent Element
145 * @param childElement the child Element
146 * @return the child Element that was added (may be an imported copy)
148 static xercesc::DOMElement* appendChildElement(xercesc::DOMElement* parentElement, xercesc::DOMElement* childElement);
151 * Checks the qualified name of a node.
153 * @param n node to check
154 * @param ns namespace to compare with
155 * @param local local name to compare with
156 * @return true iff the node's qualified name matches the other parameters
158 static bool isNodeNamed(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* local) {
159 return (n && xercesc::XMLString::equals(local,n->getLocalName()) && xercesc::XMLString::equals(ns,n->getNamespaceURI()));
163 * Returns the first matching child element of the node if any.
165 * @param n node to check
166 * @param localName local name to compare with or NULL for any match
167 * @return the first matching child node of type Element, or NULL
169 static xercesc::DOMElement* getFirstChildElement(const xercesc::DOMNode* n, const XMLCh* localName=NULL);
172 * Returns the last matching child element of the node if any.
174 * @param n node to check
175 * @param localName local name to compare with or NULL for any match
176 * @return the last matching child node of type Element, or NULL
178 static xercesc::DOMElement* getLastChildElement(const xercesc::DOMNode* n, const XMLCh* localName=NULL);
181 * Returns the next matching sibling element of the node if any.
183 * @param n node to check
184 * @param localName local name to compare with or NULL for any match
185 * @return the next matching sibling node of type Element, or NULL
187 static xercesc::DOMElement* getNextSiblingElement(const xercesc::DOMNode* n, const XMLCh* localName=NULL);
190 * Returns the previous matching sibling element of the node if any.
192 * @param n node to check
193 * @param localName local name to compare with or NULL for any match
194 * @return the previous matching sibling node of type Element, or NULL
196 static xercesc::DOMElement* getPreviousSiblingElement(const xercesc::DOMNode* n, const XMLCh* localName=NULL);
199 * Returns the first matching child element of the node if any.
201 * @param n node to check
202 * @param ns namespace to compare with
203 * @param localName local name to compare with
204 * @return the first matching child node of type Element, or NULL
206 static xercesc::DOMElement* getFirstChildElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
209 * Returns the last matching child element of the node if any.
211 * @param n node to check
212 * @param ns namespace to compare with
213 * @param localName local name to compare with
214 * @return the last matching child node of type Element, or NULL
216 static xercesc::DOMElement* getLastChildElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
219 * Returns the next matching sibling element of the node if any.
221 * @param n node to check
222 * @param ns namespace to compare with
223 * @param localName local name to compare with
224 * @return the next matching sibling node of type Element, or NULL
226 static xercesc::DOMElement* getNextSiblingElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
229 * Returns the previous matching sibling element of the node if any.
231 * @param n node to check
232 * @param ns namespace to compare with
233 * @param localName local name to compare with
234 * @return the previous matching sibling node of type Element, or NULL
236 static xercesc::DOMElement* getPreviousSiblingElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
239 * Returns the content of the first Text node found in the element, if any.
240 * This is roughly similar to the DOM getTextContent function, but only
241 * examples the immediate children of the element.
243 * @param e element to examine
244 * @return the content of the first Text node found, or NULL
246 static const XMLCh* getTextContent(const xercesc::DOMElement* e);
249 * Serializes the DOM node provided into a buffer using UTF-8 encoding and
250 * the default XML serializer available. No manipulation or formatting is applied.
252 * @param n node to serialize
253 * @param buf buffer to serialize element into
254 * @param pretty enable pretty printing if supported
256 static void serialize(const xercesc::DOMNode* n, std::string& buf, bool pretty=false);
259 * Serializes the DOM node provided to a stream using UTF-8 encoding and
260 * the default XML serializer available. No manipulation or formatting is applied.
262 * @param n node to serialize
263 * @param out stream to serialize element into
264 * @param pretty enable pretty printing if supported
265 * @return reference to output stream
267 static std::ostream& serialize(const xercesc::DOMNode* n, std::ostream& out, bool pretty=false);
271 * Serializes the DOM node provided to a stream using UTF-8 encoding and
272 * the default XML serializer available. No manipulation or formatting is applied.
274 * @param n node to serialize
275 * @param ostr stream to serialize element into
276 * @return reference to output stream
278 extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const xercesc::DOMNode& n);
281 * Marshalls and serializes the XMLObject provided to a stream using UTF-8 encoding and
282 * the default XML serializer available. No manipulation or formatting is applied.
284 * <p>The marshaller operation takes no parameters.
286 * @param obj object to serialize
287 * @param ostr stream to serialize object into
288 * @return reference to output stream
290 extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const XMLObject& obj);
293 #endif /* __xmltooling_xmlhelper_h__ */