blob: 0422ad4c707a0561fef858088176e9abdfac664f [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XNodeSet Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XNodeSet" --><!-- doxytag: inherits="XNodeSetBase" -->
<p>Class to hold <a class="el" href="classXPath.html">XPath</a> return types.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="XNodeSet_8hpp_source.html">XNodeSet.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classXNodeSetBase.html">XNodeSetBase</a>.</p>
<div class="dynheader">
Collaboration diagram for XNodeSet:</div>
<div class="dyncontent">
<div class="center"><img src="classXNodeSet__coll__graph.png" border="0" usemap="#XNodeSet_coll__map" alt="Collaboration graph"/></div>
<map name="XNodeSet_coll__map" id="XNodeSet_coll__map">
<area shape="rect" id="node2" href="classXNodeSetBase.html" title="Class to hold XPath return types." alt="" coords="1351,152,1471,181"/><area shape="rect" id="node14" href="classXNodeSetResultTreeFragProxy.html" title="XNodeSetResultTreeFragProxy" alt="" coords="1671,104,1887,133"/><area shape="rect" id="node4" href="classXObject.html" title="Class to hold XPath return types." alt="" coords="884,267,956,296"/><area shape="rect" id="node6" href="classXalanReferenceCountedObject.html" title="Class to hold reference count information." alt="" coords="357,289,576,319"/><area shape="rect" id="node8" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="408,344,525,373"/><area shape="rect" id="node35" href="classXPathExecutionContext.html" title="XPathExecutionContext" alt="" coords="833,389,1007,419"/><area shape="rect" id="node10" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="403,87,531,116"/><area shape="rect" id="node16" href="classXObjectResultTreeFragProxyBase.html" title="XObjectResultTreeFragProxyBase" alt="" coords="803,31,1037,60"/><area shape="rect" id="node12" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,87,233,116"/><area shape="rect" id="node18" href="classXalanDocumentFragment.html" title="XalanDocumentFragment" alt="" coords="373,5,560,35"/><area shape="rect" id="node20" href="classXalanNode.html" title="XalanNode" alt="" coords="73,5,167,35"/><area shape="rect" id="node25" href="classXPathExecutionContext_1_1GetCachedNodeList.html" title="XPathExecutionContext::GetCachedNodeList" alt="" coords="1257,389,1564,419"/><area shape="rect" id="node27" href="classMutableNodeRefList.html" title="Local implementation of MutableNodeRefList." alt="" coords="845,449,995,479"/><area shape="rect" id="node29" href="classNodeRefList.html" title="Local implementation of NodeRefList." alt="" coords="417,467,516,496"/><area shape="rect" id="node31" href="classNodeRefListBase.html" title="Local implementation of NodeRefList." alt="" coords="55,520,185,549"/><area shape="rect" id="node33" href="classXalanVector.html" title="XalanVector\&lt; XalanNode * \&gt;" alt="" coords="15,467,225,496"/><area shape="rect" id="node37" href="classExecutionContext.html" title="ExecutionContext" alt="" coords="400,413,533,443"/><area shape="rect" id="node39" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="41,413,199,443"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXNodeSet-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <br class="typebreak"/>
<a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">XPathExecutionContext::BorrowReturnMutableNodeRefList</a> <a class="el" href="classXNodeSet.html#a7997a68d4917bfd87d6116c50d76956a">BorrowReturnMutableNodeRefList</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXNodeSet.html#a10927d15e7d95a41b3d48673fdae1449">XNodeSet</a> (<a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">BorrowReturnMutableNodeRefList</a> &amp;value, MemoryManager &amp;theMemoryManager)
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a> from a node list. <a href="#a10927d15e7d95a41b3d48673fdae1449"></a><br/></dl><li><a class="el" href="classXNodeSet.html#a5ac3ea0aae2392b233f3c164be40cfbe">XNodeSet</a> (const <a class="el" href="classXNodeSet.html">XNodeSet</a> &amp;source, MemoryManager &amp;theMemoryManager)
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a> from another. <a href="#a5ac3ea0aae2392b233f3c164be40cfbe"></a><br/></dl><li>virtual <a class="el" href="classXNodeSet.html#a34b7f680a8be9830337731b50be59e7c">~XNodeSet</a> ()
<li>virtual const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp; <a class="el" href="classXNodeSet.html#a9d1f754cade821b5cace7957d9902794">nodeset</a> () const
<dl class="el"><dd class="mdescRight">Cast result object to a nodelist. <a href="#a9d1f754cade821b5cace7957d9902794"></a><br/></dl><li>virtual <a class="el" href="classXalanNode.html">XalanNode</a> * <a class="el" href="classXNodeSet.html#a97a6bdf7fc0eba1beda4f2fcb9203a0c">item</a> (<a class="el" href="classXNodeSetBase.html#a30f3a72f7dfe6c8bdef6ff09323646e0">size_type</a> index) const
<li>virtual <a class="el" href="classXNodeSetBase.html#a30f3a72f7dfe6c8bdef6ff09323646e0">size_type</a> <a class="el" href="classXNodeSet.html#a5e30d7ca258d294ab2aa665ed3d8bfea">getLength</a> () const
<li>void <a class="el" href="classXNodeSet.html#a18d7cb1ec36b1567062e04b2350ca3af">release</a> ()
<dl class="el"><dd class="mdescRight">Release the node set held by the instance. <a href="#a18d7cb1ec36b1567062e04b2350ca3af"></a><br/></dl><li>void <a class="el" href="classXNodeSet.html#a1026ecb9fe25e39b7afbb063c76bffd3">set</a> (<a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">BorrowReturnMutableNodeRefList</a> &amp;value)
<dl class="el"><dd class="mdescRight">Change the value of an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a>. <a href="#a1026ecb9fe25e39b7afbb063c76bffd3"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class to hold <a class="el" href="classXPath.html">XPath</a> return types. </p>
<p>Definition at line <a class="el" href="XNodeSet_8hpp_source.html#l00044">44</a> of file <a class="el" href="XNodeSet_8hpp_source.html">XNodeSet.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a7997a68d4917bfd87d6116c50d76956a"></a><!-- doxytag: member="XNodeSet::BorrowReturnMutableNodeRefList" ref="a7997a68d4917bfd87d6116c50d76956a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">XPathExecutionContext::BorrowReturnMutableNodeRefList</a> <a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">XNodeSet::BorrowReturnMutableNodeRefList</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XNodeSet_8hpp_source.html#l00048">48</a> of file <a class="el" href="XNodeSet_8hpp_source.html">XNodeSet.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a10927d15e7d95a41b3d48673fdae1449"></a><!-- doxytag: member="XNodeSet::XNodeSet" ref="a10927d15e7d95a41b3d48673fdae1449" args="(BorrowReturnMutableNodeRefList &amp;value, MemoryManager &amp;theMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XNodeSet::XNodeSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">BorrowReturnMutableNodeRefList</a> &amp;&nbsp;</td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theMemoryManager</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a> from a node list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>Pointer to source node list. The <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a> will adopt the pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theMemoryManager</em>&nbsp;</td><td>The MemoryManager for the instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5ac3ea0aae2392b233f3c164be40cfbe"></a><!-- doxytag: member="XNodeSet::XNodeSet" ref="a5ac3ea0aae2392b233f3c164be40cfbe" args="(const XNodeSet &amp;source, MemoryManager &amp;theMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XNodeSet::XNodeSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXNodeSet.html">XNodeSet</a> &amp;&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theMemoryManager</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a> from another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>object to copy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theMemoryManager</em>&nbsp;</td><td>The MemoryManager for the instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a34b7f680a8be9830337731b50be59e7c"></a><!-- doxytag: member="XNodeSet::~XNodeSet" ref="a34b7f680a8be9830337731b50be59e7c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XNodeSet::~XNodeSet </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5e30d7ca258d294ab2aa665ed3d8bfea"></a><!-- doxytag: member="XNodeSet::getLength" ref="a5e30d7ca258d294ab2aa665ed3d8bfea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXNodeSetBase.html#a30f3a72f7dfe6c8bdef6ff09323646e0">size_type</a> XNodeSet::getLength </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classXNodeSetBase.html#ac193b2dde29b7ac73f21b6022b6115c0">XNodeSetBase</a>.</p>
</div>
</div>
<a class="anchor" id="a97a6bdf7fc0eba1beda4f2fcb9203a0c"></a><!-- doxytag: member="XNodeSet::item" ref="a97a6bdf7fc0eba1beda4f2fcb9203a0c" args="(size_type index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanNode.html">XalanNode</a>* XNodeSet::item </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXNodeSetBase.html#a30f3a72f7dfe6c8bdef6ff09323646e0">size_type</a>&nbsp;</td>
<td class="paramname"> <em>index</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classXNodeSetBase.html#a61108c809806e229ac99c8e16b98a6b1">XNodeSetBase</a>.</p>
</div>
</div>
<a class="anchor" id="a9d1f754cade821b5cace7957d9902794"></a><!-- doxytag: member="XNodeSet::nodeset" ref="a9d1f754cade821b5cace7957d9902794" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a>&amp; XNodeSet::nodeset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast result object to a nodelist. </p>
<p>This function does not have access to the current <a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a>, so the result may contain data from whitespace text nodes that might have been stripped otherwise.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>executionContext</em>&nbsp;</td><td>The current <a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>node list </dd></dl>
<p>Implements <a class="el" href="classXNodeSetBase.html#a411144cd8acf1069a099d1aac41590d7">XNodeSetBase</a>.</p>
</div>
</div>
<a class="anchor" id="a18d7cb1ec36b1567062e04b2350ca3af"></a><!-- doxytag: member="XNodeSet::release" ref="a18d7cb1ec36b1567062e04b2350ca3af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XNodeSet::release </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release the node set held by the instance. </p>
</div>
</div>
<a class="anchor" id="a1026ecb9fe25e39b7afbb063c76bffd3"></a><!-- doxytag: member="XNodeSet::set" ref="a1026ecb9fe25e39b7afbb063c76bffd3" args="(BorrowReturnMutableNodeRefList &amp;value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XNodeSet::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPathExecutionContext_1_1GetCachedNodeList.html">BorrowReturnMutableNodeRefList</a> &amp;&nbsp;</td>
<td class="paramname"> <em>value</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change the value of an <a class="el" href="classXNodeSet.html" title="Class to hold XPath return types.">XNodeSet</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theValue</em>&nbsp;</td><td>The new value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XNodeSet_8hpp_source.html">XNodeSet.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>