<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>xmltooling: xmltooling::XMLObject Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">xmltooling  <span id="projectnumber">1.5.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a00105.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="a00314.html">List of all members</a> </div> <div class="headertitle"> <div class="title">xmltooling::XMLObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>Object that represents an XML Element that has been unmarshalled into this C++ object. <a href="a00105.html#details">More...</a></p> <p><code>#include <xmltooling/XMLObject.h></code></p> <div class="dynheader"> Inheritance diagram for xmltooling::XMLObject:</div> <div class="dyncontent"> <div class="center"> <img src="a00105.png" usemap="#xmltooling::XMLObject_map" alt=""/> <map id="xmltooling::XMLObject_map" name="xmltooling::XMLObject_map"> <area href="a00075.html" title="XMLObject representing XML Digital Signature, version 20020212, Signature element. " alt="xmlsignature::Signature" shape="rect" coords="0,56,288,80"/> <area href="a00006.html" title="An abstract implementation of XMLObject. " alt="xmltooling::AbstractXMLObject" shape="rect" coords="298,56,586,80"/> <area href="a00010.html" title="An XMLObject that supports arbitrary attributes. " alt="xmltooling::AttributeExtensibleXMLObject" shape="rect" coords="894,56,1182,80"/> <area href="a00031.html" title="An XMLObject that exposes arbitrary children via a mutable vector. " alt="xmltooling::ElementExtensibleXMLObject" shape="rect" coords="1490,56,1778,80"/> <area href="a00001.html" title="AbstractXMLObject mixin that implements AttributeExtensibleXMLObject. " alt="xmltooling::AbstractAttributeExtensibleXMLObject" shape="rect" coords="596,112,884,136"/> <area href="a00002.html" title="AbstractXMLObject mixin that implements children. " alt="xmltooling::AbstractComplexElement" shape="rect" coords="596,168,884,192"/> <area href="a00003.html" title="AbstractXMLObject mixin that implements DOM caching. " alt="xmltooling::AbstractDOMCachingXMLObject" shape="rect" coords="596,224,884,248"/> <area href="a00005.html" title="AbstractXMLObject mixin that implements a simple string-based content model. " alt="xmltooling::AbstractSimpleElement" shape="rect" coords="596,280,884,304"/> <area href="a00007.html" title="A mix-in to implement object marshalling with DOM reuse. " alt="xmltooling::AbstractXMLObjectMarshaller" shape="rect" coords="596,336,884,360"/> <area href="a00008.html" title="A mix-in to implement object unmarshalling. " alt="xmltooling::AbstractXMLObjectUnmarshaller" shape="rect" coords="596,392,884,416"/> <area href="a00001.html" title="AbstractXMLObject mixin that implements AttributeExtensibleXMLObject. " alt="xmltooling::AbstractAttributeExtensibleXMLObject" shape="rect" coords="1192,112,1480,136"/> <area href="a00032.html" title="An XMLObject with an open content model. " alt="xmltooling::ElementProxy" shape="rect" coords="1192,168,1480,192"/> <area href="a00032.html" title="An XMLObject with an open content model. " alt="xmltooling::ElementProxy" shape="rect" coords="1490,112,1778,136"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a133c8a0972116c6a2315157261d962de"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00105.html">XMLObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a133c8a0972116c6a2315157261d962de">clone</a> () const =0</td></tr> <tr class="memdesc:a133c8a0972116c6a2315157261d962de"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of the object, along with all of its children. <a href="#a133c8a0972116c6a2315157261d962de">More...</a><br /></td></tr> <tr class="separator:a133c8a0972116c6a2315157261d962de"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aca3ff8bdec5b00c97f5808a4c5a17c55"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#aca3ff8bdec5b00c97f5808a4c5a17c55">detach</a> ()=0</td></tr> <tr class="memdesc:aca3ff8bdec5b00c97f5808a4c5a17c55"><td class="mdescLeft"> </td><td class="mdescRight">Specialized function for detaching a child object from its parent <b>while disposing of the parent</b>. <a href="#aca3ff8bdec5b00c97f5808a4c5a17c55">More...</a><br /></td></tr> <tr class="separator:aca3ff8bdec5b00c97f5808a4c5a17c55"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ae4e9bc225761ad551a11d41f6d116d"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00069.html">QName</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a0ae4e9bc225761ad551a11d41f6d116d">getElementQName</a> () const =0</td></tr> <tr class="memdesc:a0ae4e9bc225761ad551a11d41f6d116d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="a00069.html" title="A data structure for encapsulating XML QNames. ">QName</a> for this element. <a href="#a0ae4e9bc225761ad551a11d41f6d116d">More...</a><br /></td></tr> <tr class="separator:a0ae4e9bc225761ad551a11d41f6d116d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d5b9b55898b9a48a533f87531a8ff33"><td class="memItemLeft" align="right" valign="top">virtual const std::set<br class="typebreak" /> < <a class="el" href="a00054.html">Namespace</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a1d5b9b55898b9a48a533f87531a8ff33">getNamespaces</a> () const =0</td></tr> <tr class="memdesc:a1d5b9b55898b9a48a533f87531a8ff33"><td class="mdescLeft"> </td><td class="mdescRight">Gets the namespaces that are scoped to this element. <a href="#a1d5b9b55898b9a48a533f87531a8ff33">More...</a><br /></td></tr> <tr class="separator:a1d5b9b55898b9a48a533f87531a8ff33"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4596a523687399fb67b6257779925232"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a4596a523687399fb67b6257779925232">addNamespace</a> (const <a class="el" href="a00054.html">Namespace</a> &ns) const =0</td></tr> <tr class="memdesc:a4596a523687399fb67b6257779925232"><td class="mdescLeft"> </td><td class="mdescRight">Adds a namespace to the ones already scoped to this element. <a href="#a4596a523687399fb67b6257779925232">More...</a><br /></td></tr> <tr class="separator:a4596a523687399fb67b6257779925232"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab23df5e4e3a559308dd40c0d8e82c505"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ab23df5e4e3a559308dd40c0d8e82c505">removeNamespace</a> (const <a class="el" href="a00054.html">Namespace</a> &ns)=0</td></tr> <tr class="memdesc:ab23df5e4e3a559308dd40c0d8e82c505"><td class="mdescLeft"> </td><td class="mdescRight">Removes a namespace from this element. <a href="#ab23df5e4e3a559308dd40c0d8e82c505">More...</a><br /></td></tr> <tr class="separator:ab23df5e4e3a559308dd40c0d8e82c505"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a274ff5fce9397de658988ed7bb3e4b07"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00069.html">QName</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a274ff5fce9397de658988ed7bb3e4b07">getSchemaType</a> () const =0</td></tr> <tr class="memdesc:a274ff5fce9397de658988ed7bb3e4b07"><td class="mdescLeft"> </td><td class="mdescRight">Gets the XML schema type of this element. <a href="#a274ff5fce9397de658988ed7bb3e4b07">More...</a><br /></td></tr> <tr class="separator:a274ff5fce9397de658988ed7bb3e4b07"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af214019ec0b9de2dd0ccfc9bb51b01b5"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#af214019ec0b9de2dd0ccfc9bb51b01b5">getXMLID</a> () const =0</td></tr> <tr class="memdesc:af214019ec0b9de2dd0ccfc9bb51b01b5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of the ID attribute set on this object, if any. <a href="#af214019ec0b9de2dd0ccfc9bb51b01b5">More...</a><br /></td></tr> <tr class="separator:af214019ec0b9de2dd0ccfc9bb51b01b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7d5896fba25112f8c8f00fb474ecdba4"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a7d5896fba25112f8c8f00fb474ecdba4">getLang</a> () const </td></tr> <tr class="memdesc:a7d5896fba25112f8c8f00fb474ecdba4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the xml:lang property of the object, if any. <a href="#a7d5896fba25112f8c8f00fb474ecdba4">More...</a><br /></td></tr> <tr class="separator:a7d5896fba25112f8c8f00fb474ecdba4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab671e23e25f21a5f8643261e2744430b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ab671e23e25f21a5f8643261e2744430b">nil</a> () const </td></tr> <tr class="memdesc:ab671e23e25f21a5f8643261e2744430b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the xsi:nil property of the object, or false if not set. <a href="#ab671e23e25f21a5f8643261e2744430b">More...</a><br /></td></tr> <tr class="separator:ab671e23e25f21a5f8643261e2744430b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2108546dd24deac62dfb3c490c56e6e5"><td class="memItemLeft" align="right" valign="top">virtual <br class="typebreak" /> <a class="el" href="a00203.html#aa6078fc438e1b22b707db1a66ebc2a89">xmlconstants::xmltooling_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a2108546dd24deac62dfb3c490c56e6e5">getNil</a> () const =0</td></tr> <tr class="memdesc:a2108546dd24deac62dfb3c490c56e6e5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the xsi:nil property as an explicit enumerated value. <a href="#a2108546dd24deac62dfb3c490c56e6e5">More...</a><br /></td></tr> <tr class="separator:a2108546dd24deac62dfb3c490c56e6e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afff8f2458a76170b643bd32e40e3180d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#afff8f2458a76170b643bd32e40e3180d">nil</a> (<a class="el" href="a00203.html#aa6078fc438e1b22b707db1a66ebc2a89">xmlconstants::xmltooling_bool_t</a> value)=0</td></tr> <tr class="memdesc:afff8f2458a76170b643bd32e40e3180d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the xsi:nil property using an enumerated value. <a href="#afff8f2458a76170b643bd32e40e3180d">More...</a><br /></td></tr> <tr class="separator:afff8f2458a76170b643bd32e40e3180d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6b646f095bb43b960e85ea9b5ed8602a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a6b646f095bb43b960e85ea9b5ed8602a">nil</a> (bool value)</td></tr> <tr class="memdesc:a6b646f095bb43b960e85ea9b5ed8602a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the xsi:nil property. <a href="#a6b646f095bb43b960e85ea9b5ed8602a">More...</a><br /></td></tr> <tr class="separator:a6b646f095bb43b960e85ea9b5ed8602a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab28c3e581db3c81a0b7d45c0deb6e7fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ab28c3e581db3c81a0b7d45c0deb6e7fe">setNil</a> (const XMLCh *value)</td></tr> <tr class="memdesc:ab28c3e581db3c81a0b7d45c0deb6e7fe"><td class="mdescLeft"> </td><td class="mdescRight">Sets the xsi:nil property using a string constant. <a href="#ab28c3e581db3c81a0b7d45c0deb6e7fe">More...</a><br /></td></tr> <tr class="separator:ab28c3e581db3c81a0b7d45c0deb6e7fe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae8e6e5a70e5d4d7bae939e99d99c3de3"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ae8e6e5a70e5d4d7bae939e99d99c3de3">hasParent</a> () const =0</td></tr> <tr class="memdesc:ae8e6e5a70e5d4d7bae939e99d99c3de3"><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if this object has a parent. <a href="#ae8e6e5a70e5d4d7bae939e99d99c3de3">More...</a><br /></td></tr> <tr class="separator:ae8e6e5a70e5d4d7bae939e99d99c3de3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d6db6c0152f48534573ab2fd787cdb4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00105.html">XMLObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a8d6db6c0152f48534573ab2fd787cdb4">getParent</a> () const =0</td></tr> <tr class="memdesc:a8d6db6c0152f48534573ab2fd787cdb4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the parent of this element or null if there is no parent. <a href="#a8d6db6c0152f48534573ab2fd787cdb4">More...</a><br /></td></tr> <tr class="separator:a8d6db6c0152f48534573ab2fd787cdb4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ef2b88f76039de6fde04a7222d7137d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a0ef2b88f76039de6fde04a7222d7137d">setParent</a> (<a class="el" href="a00105.html">XMLObject</a> *parent)=0</td></tr> <tr class="memdesc:a0ef2b88f76039de6fde04a7222d7137d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the parent of this element. <a href="#a0ef2b88f76039de6fde04a7222d7137d">More...</a><br /></td></tr> <tr class="separator:a0ef2b88f76039de6fde04a7222d7137d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a256d43af739f55f5de99f9c5ebce5598"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a256d43af739f55f5de99f9c5ebce5598">hasChildren</a> () const =0</td></tr> <tr class="memdesc:a256d43af739f55f5de99f9c5ebce5598"><td class="mdescLeft"> </td><td class="mdescRight">Checks if this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> has children. <a href="#a256d43af739f55f5de99f9c5ebce5598">More...</a><br /></td></tr> <tr class="separator:a256d43af739f55f5de99f9c5ebce5598"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a878cffcb4470dd8eee198294795add9b"><td class="memItemLeft" align="right" valign="top">virtual const std::list<br class="typebreak" /> < <a class="el" href="a00105.html">XMLObject</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a878cffcb4470dd8eee198294795add9b">getOrderedChildren</a> () const =0</td></tr> <tr class="memdesc:a878cffcb4470dd8eee198294795add9b"><td class="mdescLeft"> </td><td class="mdescRight">Returns an unmodifiable list of child objects in the order that they should appear in the serialized representation. <a href="#a878cffcb4470dd8eee198294795add9b">More...</a><br /></td></tr> <tr class="separator:a878cffcb4470dd8eee198294795add9b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2b9dcfc445191677b2ecbc6cebd19073"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a2b9dcfc445191677b2ecbc6cebd19073">removeChild</a> (<a class="el" href="a00105.html">XMLObject</a> *child)=0</td></tr> <tr class="memdesc:a2b9dcfc445191677b2ecbc6cebd19073"><td class="mdescLeft"> </td><td class="mdescRight">Used by a child's detach method to isolate the child from this parent object in preparation for destroying the parent (this object). <a href="#a2b9dcfc445191677b2ecbc6cebd19073">More...</a><br /></td></tr> <tr class="separator:a2b9dcfc445191677b2ecbc6cebd19073"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac1a515dbadf9e6e3ed4ba6954df7bd2f"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ac1a515dbadf9e6e3ed4ba6954df7bd2f">getTextContent</a> (unsigned int position=0) const =0</td></tr> <tr class="memdesc:ac1a515dbadf9e6e3ed4ba6954df7bd2f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the text content at the specified position relative to any child elements. <a href="#ac1a515dbadf9e6e3ed4ba6954df7bd2f">More...</a><br /></td></tr> <tr class="separator:ac1a515dbadf9e6e3ed4ba6954df7bd2f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8667f3cb026c569ba226fb805efc4f69"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a8667f3cb026c569ba226fb805efc4f69">setTextContent</a> (const XMLCh *value, unsigned int position=0)=0</td></tr> <tr class="memdesc:a8667f3cb026c569ba226fb805efc4f69"><td class="mdescLeft"> </td><td class="mdescRight">Sets (or clears) text content relative to a child element's position. <a href="#a8667f3cb026c569ba226fb805efc4f69">More...</a><br /></td></tr> <tr class="separator:a8667f3cb026c569ba226fb805efc4f69"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9964e5c214c2cd637a1fe9562fa3b3cf"><td class="memItemLeft" align="right" valign="top">virtual xercesc::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a9964e5c214c2cd637a1fe9562fa3b3cf">getDOM</a> () const =0</td></tr> <tr class="memdesc:a9964e5c214c2cd637a1fe9562fa3b3cf"><td class="mdescLeft"> </td><td class="mdescRight">Gets the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>, if one exists. <a href="#a9964e5c214c2cd637a1fe9562fa3b3cf">More...</a><br /></td></tr> <tr class="separator:a9964e5c214c2cd637a1fe9562fa3b3cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaba949e28cf8b0aa1417086c185c96a9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#aaba949e28cf8b0aa1417086c185c96a9">setDOM</a> (xercesc::DOMElement *dom, bool bindDocument=false) const =0</td></tr> <tr class="memdesc:aaba949e28cf8b0aa1417086c185c96a9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. <a href="#aaba949e28cf8b0aa1417086c185c96a9">More...</a><br /></td></tr> <tr class="separator:aaba949e28cf8b0aa1417086c185c96a9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abe10e16c3b069d0f951cbe7b949a6605"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#abe10e16c3b069d0f951cbe7b949a6605">setDocument</a> (xercesc::DOMDocument *doc) const =0</td></tr> <tr class="memdesc:abe10e16c3b069d0f951cbe7b949a6605"><td class="mdescLeft"> </td><td class="mdescRight">Assigns ownership of a DOM document to the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. <a href="#abe10e16c3b069d0f951cbe7b949a6605">More...</a><br /></td></tr> <tr class="separator:abe10e16c3b069d0f951cbe7b949a6605"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace8b45fff6b6551dba30ac3b0987e724"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace8b45fff6b6551dba30ac3b0987e724"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ace8b45fff6b6551dba30ac3b0987e724">releaseDOM</a> () const =0</td></tr> <tr class="memdesc:ace8b45fff6b6551dba30ac3b0987e724"><td class="mdescLeft"> </td><td class="mdescRight">Releases the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>, if there is one. <br /></td></tr> <tr class="separator:ace8b45fff6b6551dba30ac3b0987e724"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0620ccae7799b977e306396350f1dfd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ab0620ccae7799b977e306396350f1dfd">releaseParentDOM</a> (bool propagateRelease=true) const =0</td></tr> <tr class="memdesc:ab0620ccae7799b977e306396350f1dfd"><td class="mdescLeft"> </td><td class="mdescRight">Releases the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>'s parent. <a href="#ab0620ccae7799b977e306396350f1dfd">More...</a><br /></td></tr> <tr class="separator:ab0620ccae7799b977e306396350f1dfd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73e422bf5d64f6d26f9b3da2f99967b8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a73e422bf5d64f6d26f9b3da2f99967b8">releaseChildrenDOM</a> (bool propagateRelease=true) const =0</td></tr> <tr class="memdesc:a73e422bf5d64f6d26f9b3da2f99967b8"><td class="mdescLeft"> </td><td class="mdescRight">Releases the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>'s children. <a href="#a73e422bf5d64f6d26f9b3da2f99967b8">More...</a><br /></td></tr> <tr class="separator:a73e422bf5d64f6d26f9b3da2f99967b8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83644a25feb5e1c4220cfe1e0bb0e1d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83644a25feb5e1c4220cfe1e0bb0e1d8"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a83644a25feb5e1c4220cfe1e0bb0e1d8">releaseThisandParentDOM</a> () const </td></tr> <tr class="memdesc:a83644a25feb5e1c4220cfe1e0bb0e1d8"><td class="mdescLeft"> </td><td class="mdescRight">A convenience method that is equal to calling <a class="el" href="a00105.html#ace8b45fff6b6551dba30ac3b0987e724" title="Releases the DOM representation of this XMLObject, if there is one. ">releaseDOM()</a> then releaseParentDOM(true). <br /></td></tr> <tr class="separator:a83644a25feb5e1c4220cfe1e0bb0e1d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aef128697e8b5a3fb70f554ebc55933e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef128697e8b5a3fb70f554ebc55933e2"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#aef128697e8b5a3fb70f554ebc55933e2">releaseThisAndChildrenDOM</a> () const </td></tr> <tr class="memdesc:aef128697e8b5a3fb70f554ebc55933e2"><td class="mdescLeft"> </td><td class="mdescRight">A convenience method that is equal to calling releaseChildrenDOM(true) then <a class="el" href="a00105.html#ace8b45fff6b6551dba30ac3b0987e724" title="Releases the DOM representation of this XMLObject, if there is one. ">releaseDOM()</a>. <br /></td></tr> <tr class="separator:aef128697e8b5a3fb70f554ebc55933e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5c12d9a2a2bf0e98a046bf225ab7d28b"><td class="memItemLeft" align="right" valign="top">virtual xercesc::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a5c12d9a2a2bf0e98a046bf225ab7d28b">marshall</a> (xercesc::DOMDocument *document=0, const std::vector< <a class="el" href="a00075.html">xmlsignature::Signature</a> * > *sigs=0, const <a class="el" href="a00023.html">Credential</a> *credential=0) const =0</td></tr> <tr class="memdesc:a5c12d9a2a2bf0e98a046bf225ab7d28b"><td class="mdescLeft"> </td><td class="mdescRight">Marshalls the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>, and its children, into a DOM element. <a href="#a5c12d9a2a2bf0e98a046bf225ab7d28b">More...</a><br /></td></tr> <tr class="separator:a5c12d9a2a2bf0e98a046bf225ab7d28b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a064c6f634e5e2edf8e756a5632913464"><td class="memItemLeft" align="right" valign="top">virtual xercesc::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a064c6f634e5e2edf8e756a5632913464">marshall</a> (xercesc::DOMElement *parentElement, const std::vector< <a class="el" href="a00075.html">xmlsignature::Signature</a> * > *sigs=0, const <a class="el" href="a00023.html">Credential</a> *credential=0) const =0</td></tr> <tr class="memdesc:a064c6f634e5e2edf8e756a5632913464"><td class="mdescLeft"> </td><td class="mdescRight">Marshalls the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> and appends it as a child of the given parent element. <a href="#a064c6f634e5e2edf8e756a5632913464">More...</a><br /></td></tr> <tr class="separator:a064c6f634e5e2edf8e756a5632913464"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0ea2e523e0f59ed2310fd6f3fd7cb10"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00105.html">XMLObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ab0ea2e523e0f59ed2310fd6f3fd7cb10">unmarshall</a> (xercesc::DOMElement *element, bool bindDocument=false)=0</td></tr> <tr class="memdesc:ab0ea2e523e0f59ed2310fd6f3fd7cb10"><td class="mdescLeft"> </td><td class="mdescRight">Unmarshalls the given W3C DOM element into the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. <a href="#ab0ea2e523e0f59ed2310fd6f3fd7cb10">More...</a><br /></td></tr> <tr class="separator:ab0ea2e523e0f59ed2310fd6f3fd7cb10"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Object that represents an XML Element that has been unmarshalled into this C++ object. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a4596a523687399fb67b6257779925232"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::addNamespace </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00054.html">Namespace</a> & </td> <td class="paramname"><em>ns</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Adds a namespace to the ones already scoped to this element. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ns</td><td>the namespace to add </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00006.html#a31c5461445610826a2eaa700a095b900">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a133c8a0972116c6a2315157261d962de"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a00105.html">XMLObject</a>* xmltooling::XMLObject::clone </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a copy of the object, along with all of its children. </p> <p>The new object tree will be completely distinct and independent of the original in all respects. </p> <p>Implemented in <a class="el" href="a00003.html#aeb30158b0bcfb169766ccb45606e5ae4">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="aca3ff8bdec5b00c97f5808a4c5a17c55"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::detach </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Specialized function for detaching a child object from its parent <b>while disposing of the parent</b>. </p> <p>This is not a generic way of detaching any child object, but only of pruning a single child from the root of an <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> tree. If the detached <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>'s parent is itself a child, an exception will be thrown. It's mainly useful for turning a child into the new root of the tree without having to clone the child. </p> <p>Implemented in <a class="el" href="a00006.html#af415968057f0c1cbec24b06653a6a027">xmltooling::AbstractXMLObject</a>, and <a class="el" href="a00003.html#a0503d609f11b97306d87c7fc058daf7e">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="a9964e5c214c2cd637a1fe9562fa3b3cf"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual xercesc::DOMElement* xmltooling::XMLObject::getDOM </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>, if one exists. </p> <dl class="section return"><dt>Returns</dt><dd>the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> </dd></dl> <p>Implemented in <a class="el" href="a00003.html#a406724abfb9be7a3d5cf7c59ac26d44f">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="a0ae4e9bc225761ad551a11d41f6d116d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="a00069.html">QName</a>& xmltooling::XMLObject::getElementQName </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the <a class="el" href="a00069.html" title="A data structure for encapsulating XML QNames. ">QName</a> for this element. </p> <p>This <a class="el" href="a00069.html" title="A data structure for encapsulating XML QNames. ">QName</a> <b>MUST</b> contain the namespace URI, namespace prefix, and local element name.</p> <dl class="section return"><dt>Returns</dt><dd>constant reference to the <a class="el" href="a00069.html" title="A data structure for encapsulating XML QNames. ">QName</a> for this object </dd></dl> <p>Implemented in <a class="el" href="a00006.html#a454019b44d961c6aecc25ae416424020">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a7d5896fba25112f8c8f00fb474ecdba4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const XMLCh* xmltooling::XMLObject::getLang </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the xml:lang property of the object, if any. </p> <dl class="section return"><dt>Returns</dt><dd>an xml:lang value, or nullptr </dd></dl> <p>Reimplemented in <a class="el" href="a00001.html#ab84162c176facdc030c681164d1b6cba">xmltooling::AbstractAttributeExtensibleXMLObject</a>.</p> </div> </div> <a class="anchor" id="a1d5b9b55898b9a48a533f87531a8ff33"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const std::set<<a class="el" href="a00054.html">Namespace</a>>& xmltooling::XMLObject::getNamespaces </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the namespaces that are scoped to this element. </p> <p>The caller MUST NOT modify the set returned, but may use any non-modifying operations or algorithms on it. Iterators will remain valid unless the set member referenced is removed using the removeNamespace method.</p> <dl class="section return"><dt>Returns</dt><dd>the namespaces that are scoped to this element </dd></dl> <p>Implemented in <a class="el" href="a00006.html#aed15e63d9d32e3adf314f50348725787">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a2108546dd24deac62dfb3c490c56e6e5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a00203.html#aa6078fc438e1b22b707db1a66ebc2a89">xmlconstants::xmltooling_bool_t</a> xmltooling::XMLObject::getNil </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the xsi:nil property as an explicit enumerated value. </p> <dl class="section return"><dt>Returns</dt><dd>the xsi:nil property </dd></dl> <p>Implemented in <a class="el" href="a00006.html#a76c56f7d4aeeefa698d6bb85fac13073">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a878cffcb4470dd8eee198294795add9b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const std::list<<a class="el" href="a00105.html">XMLObject</a>*>& xmltooling::XMLObject::getOrderedChildren </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns an unmodifiable list of child objects in the order that they should appear in the serialized representation. </p> <p>The validity of the returned list is not maintained if any non-const operations are performed on the parent object.</p> <dl class="section return"><dt>Returns</dt><dd>the list of children </dd></dl> <p>Implemented in <a class="el" href="a00002.html#ab43b86deddc2f9e9aa06fa7a0a168a27">xmltooling::AbstractComplexElement</a>, and <a class="el" href="a00005.html#a535150fd056059a3e0d16e42ef05261f">xmltooling::AbstractSimpleElement</a>.</p> </div> </div> <a class="anchor" id="a8d6db6c0152f48534573ab2fd787cdb4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a00105.html">XMLObject</a>* xmltooling::XMLObject::getParent </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the parent of this element or null if there is no parent. </p> <dl class="section return"><dt>Returns</dt><dd>the parent of this element or null </dd></dl> <p>Implemented in <a class="el" href="a00006.html#a53c9477ba443bb95cd0a22e1290621e2">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a274ff5fce9397de658988ed7bb3e4b07"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="a00069.html">QName</a>* xmltooling::XMLObject::getSchemaType </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the XML schema type of this element. </p> <p>This translates to contents the xsi:type attribute for the element.</p> <dl class="section return"><dt>Returns</dt><dd>XML schema type of this element </dd></dl> <p>Implemented in <a class="el" href="a00006.html#abec60f9d418a63c6724c1a9f382c576b">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="ac1a515dbadf9e6e3ed4ba6954df7bd2f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const XMLCh* xmltooling::XMLObject::getTextContent </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>position</em> = <code>0</code></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the text content at the specified position relative to any child elements. </p> <p>A zero represents leading text, 1 comes after the first child, and so forth.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">position</td><td>the relative child element position of the text </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the designated text value </dd></dl> <p>Implemented in <a class="el" href="a00002.html#afecec7bdb997fe641cd77301410fff07">xmltooling::AbstractComplexElement</a>, and <a class="el" href="a00005.html#a48af73c65783ea3f2e1519abd8f7e1c4">xmltooling::AbstractSimpleElement</a>.</p> </div> </div> <a class="anchor" id="af214019ec0b9de2dd0ccfc9bb51b01b5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const XMLCh* xmltooling::XMLObject::getXMLID </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the value of the ID attribute set on this object, if any. </p> <dl class="section return"><dt>Returns</dt><dd>an ID value or nullptr </dd></dl> <p>Implemented in <a class="el" href="a00006.html#ad85e7ed83fcebb20b2cbd1d89db7449f">xmltooling::AbstractXMLObject</a>, and <a class="el" href="a00001.html#a1a6c0b430d8c6ede351a058161447b50">xmltooling::AbstractAttributeExtensibleXMLObject</a>.</p> </div> </div> <a class="anchor" id="a256d43af739f55f5de99f9c5ebce5598"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool xmltooling::XMLObject::hasChildren </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Checks if this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> has children. </p> <dl class="section return"><dt>Returns</dt><dd>true if this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> has children, false if not </dd></dl> <p>Implemented in <a class="el" href="a00002.html#a3a905a2d96fc0304b36644980a32a788">xmltooling::AbstractComplexElement</a>, and <a class="el" href="a00005.html#ac6ecedb5dbb9615758b9a626a9a7f234">xmltooling::AbstractSimpleElement</a>.</p> </div> </div> <a class="anchor" id="ae8e6e5a70e5d4d7bae939e99d99c3de3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool xmltooling::XMLObject::hasParent </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Checks to see if this object has a parent. </p> <dl class="section return"><dt>Returns</dt><dd>true if the object has a parent, false if not </dd></dl> <p>Implemented in <a class="el" href="a00006.html#acefeb873513685a3aa5b75aea4f7e115">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a5c12d9a2a2bf0e98a046bf225ab7d28b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual xercesc::DOMElement* xmltooling::XMLObject::marshall </td> <td>(</td> <td class="paramtype">xercesc::DOMDocument * </td> <td class="paramname"><em>document</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< <a class="el" href="a00075.html">xmlsignature::Signature</a> * > * </td> <td class="paramname"><em>sigs</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00023.html">Credential</a> * </td> <td class="paramname"><em>credential</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Marshalls the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>, and its children, into a DOM element. </p> <p>If a document is supplied, then it will be used to create the resulting elements. If the document does not have a Document Element set, then the resulting element will be set as the Document Element. If no document is supplied, then a new document will be created and bound to the lifetime of the root object being marshalled, unless an existing DOM can be reused without creating a new document.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">document</td><td>the DOM document the marshalled element will be placed in, or nullptr </td></tr> <tr><td class="paramname">sigs</td><td>ordered array of signatures to create after marshalling is complete </td></tr> <tr><td class="paramname">credential</td><td>optional credential to supply signing key and related info </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the DOM element representing this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a></dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="a00051.html" title="Exceptions during object marshalling. ">MarshallingException</a></td><td>thrown if there is a problem marshalling the given object </td></tr> <tr><td class="paramname">SignatureException</td><td>thrown if a problem occurs during signature creation </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00007.html#aef76a65552cf8096bd0c013d89708f8e">xmltooling::AbstractXMLObjectMarshaller</a>.</p> </div> </div> <a class="anchor" id="a064c6f634e5e2edf8e756a5632913464"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual xercesc::DOMElement* xmltooling::XMLObject::marshall </td> <td>(</td> <td class="paramtype">xercesc::DOMElement * </td> <td class="paramname"><em>parentElement</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< <a class="el" href="a00075.html">xmlsignature::Signature</a> * > * </td> <td class="paramname"><em>sigs</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00023.html">Credential</a> * </td> <td class="paramname"><em>credential</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Marshalls the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> and appends it as a child of the given parent element. </p> <p><b>NOTE:</b> The given Element must be within a DOM tree rooted in the Document owning the given Element.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">parentElement</td><td>the parent element to append the resulting DOM tree </td></tr> <tr><td class="paramname">sigs</td><td>ordered array of signatures to create after marshalling is complete </td></tr> <tr><td class="paramname">credential</td><td>optional credential to supply signing key and related info </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the marshalled element tree</dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="a00051.html" title="Exceptions during object marshalling. ">MarshallingException</a></td><td>thrown if the given <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> can not be marshalled. </td></tr> <tr><td class="paramname">SignatureException</td><td>thrown if a problem occurs during signature creation </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00007.html#a281f7b8973047f3615e511209ece316b">xmltooling::AbstractXMLObjectMarshaller</a>.</p> </div> </div> <a class="anchor" id="ab671e23e25f21a5f8643261e2744430b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool xmltooling::XMLObject::nil </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the xsi:nil property of the object, or false if not set. </p> <dl class="section return"><dt>Returns</dt><dd>the xsi:nil property </dd></dl> </div> </div> <a class="anchor" id="afff8f2458a76170b643bd32e40e3180d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::nil </td> <td>(</td> <td class="paramtype"><a class="el" href="a00203.html#aa6078fc438e1b22b707db1a66ebc2a89">xmlconstants::xmltooling_bool_t</a> </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the xsi:nil property using an enumerated value. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>value to set </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00006.html#a31b2f16b612ea8235f7e7957ee634725">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a6b646f095bb43b960e85ea9b5ed8602a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void xmltooling::XMLObject::nil </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the xsi:nil property. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>value to set </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a73e422bf5d64f6d26f9b3da2f99967b8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::releaseChildrenDOM </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>propagateRelease</em> = <code>true</code></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Releases the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>'s children. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">propagateRelease</td><td>true if all descendants of this element should release their DOM </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00003.html#a9049abd9e8ce119f15efeb1b89323d3b">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="ab0620ccae7799b977e306396350f1dfd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::releaseParentDOM </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>propagateRelease</em> = <code>true</code></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Releases the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>'s parent. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">propagateRelease</td><td>true if all ancestors of this element should release their DOM </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00003.html#a6c87721a19964c17154bed3b51ef5a56">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="a2b9dcfc445191677b2ecbc6cebd19073"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::removeChild </td> <td>(</td> <td class="paramtype"><a class="el" href="a00105.html">XMLObject</a> * </td> <td class="paramname"><em>child</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Used by a child's detach method to isolate the child from this parent object in preparation for destroying the parent (this object). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">child</td><td>the child object to remove </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00002.html#ad39d0efe2c5337cfa4aeaea19f2a8fa8">xmltooling::AbstractComplexElement</a>, and <a class="el" href="a00005.html#abbc112402135a28bd1f51afee36e2e35">xmltooling::AbstractSimpleElement</a>.</p> </div> </div> <a class="anchor" id="ab23df5e4e3a559308dd40c0d8e82c505"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::removeNamespace </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00054.html">Namespace</a> & </td> <td class="paramname"><em>ns</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Removes a namespace from this element. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ns</td><td>the namespace to remove </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00006.html#a0198eba2779b6d2f5710b2eb16b95d93">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="abe10e16c3b069d0f951cbe7b949a6605"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::setDocument </td> <td>(</td> <td class="paramtype">xercesc::DOMDocument * </td> <td class="paramname"><em>doc</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Assigns ownership of a DOM document to the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. </p> <p>This binds the lifetime of the document to the lifetime of the object.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">doc</td><td>DOM document bound to this object </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00003.html#ac53a4c2c467616fe169ab8bd6d83e8c1">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="aaba949e28cf8b0aa1417086c185c96a9"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::setDOM </td> <td>(</td> <td class="paramtype">xercesc::DOMElement * </td> <td class="paramname"><em>dom</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>bindDocument</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dom</td><td>DOM representation of this <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> </td></tr> <tr><td class="paramname">bindDocument</td><td>true if the object should take ownership of the associated Document </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00003.html#a0fccdc522c24256a8e7419cb4c062621">xmltooling::AbstractDOMCachingXMLObject</a>.</p> </div> </div> <a class="anchor" id="ab28c3e581db3c81a0b7d45c0deb6e7fe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void xmltooling::XMLObject::setNil </td> <td>(</td> <td class="paramtype">const XMLCh * </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the xsi:nil property using a string constant. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>value to set </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a0ef2b88f76039de6fde04a7222d7137d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::setParent </td> <td>(</td> <td class="paramtype"><a class="el" href="a00105.html">XMLObject</a> * </td> <td class="paramname"><em>parent</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the parent of this element. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">parent</td><td>the parent of this element </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00006.html#a28f7879555fa61690c2951699545e36d">xmltooling::AbstractXMLObject</a>.</p> </div> </div> <a class="anchor" id="a8667f3cb026c569ba226fb805efc4f69"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void xmltooling::XMLObject::setTextContent </td> <td>(</td> <td class="paramtype">const XMLCh * </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>position</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets (or clears) text content relative to a child element's position. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>value to set, or nullptr to clear </td></tr> <tr><td class="paramname">position</td><td>position relative to child element </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00002.html#a41bc6152306602c043927e3697007068">xmltooling::AbstractComplexElement</a>, and <a class="el" href="a00005.html#ac94d0bd19c5219613779f2ebe3e97647">xmltooling::AbstractSimpleElement</a>.</p> </div> </div> <a class="anchor" id="ab0ea2e523e0f59ed2310fd6f3fd7cb10"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a00105.html">XMLObject</a>* xmltooling::XMLObject::unmarshall </td> <td>(</td> <td class="paramtype">xercesc::DOMElement * </td> <td class="paramname"><em>element</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>bindDocument</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Unmarshalls the given W3C DOM element into the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a>. </p> <p>The root of a given XML construct should be unmarshalled with the bindDocument parameter set to true.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">element</td><td>the DOM element to unmarshall </td></tr> <tr><td class="paramname">bindDocument</td><td>true iff the resulting <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> should take ownership of the DOM's Document</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the unmarshalled <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a></dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="a00095.html" title="Exceptions during object unmarshalling. ">UnmarshallingException</a></td><td>thrown if an error occurs unmarshalling the DOM element into the <a class="el" href="a00105.html" title="Object that represents an XML Element that has been unmarshalled into this C++ object. ">XMLObject</a> </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00008.html#aa8588b8aa3698573417a5c64b9bf6d5b">xmltooling::AbstractXMLObjectUnmarshaller</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>xmltooling/<a class="el" href="a00198.html">XMLObject.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00105.html">XMLObject</a></li> <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li> </ul> </div> </body> </html>