Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classXNodeSet.html
blob: 74879f7fcddc94f92119dc47ec8ff53f53c78d1c [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XNodeSet Class Reference</h1>Class to hold <a class="el" href="classXPath.html">XPath</a> return types.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XNodeSet_8hpp-source.html">XNodeSet.hpp</a>&gt;</code>
<p>
Inheritance diagram for XNodeSet:<p><center><img src="classXNodeSet__inherit__graph.gif" border="0" usemap="#XNodeSet_inherit_map" alt="Inheritance graph"></center>
<map name="XNodeSet_inherit_map">
<area href="classXSpan.html" shape="rect" coords="76,341,134,317">
<area href="classXNodeSetBase.html" shape="rect" coords="53,191,157,168">
<area href="classXObject.html" shape="rect" coords="72,117,138,93">
<area href="classXalanReferenceCountedObject.html" shape="rect" coords="6,42,204,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XNodeSet:<p><center><img src="classXNodeSet__coll__graph.gif" border="0" usemap="#XNodeSet_coll_map" alt="Collaboration graph"></center>
<map name="XNodeSet_coll_map">
<area href="classXNodeSetBase.html" shape="rect" coords="130,325,234,301">
<area href="classXNodeSetResultTreeFragProxy.html" shape="rect" coords="93,416,293,392">
<area href="classXObject.html" shape="rect" coords="178,234,245,210">
<area href="classXalanDOMString.html" shape="rect" coords="32,42,149,18">
<area href="classXPathExecutionContext_1_1BorrowReturnMutableNodeRefList.html" shape="rect" coords="258,325,608,301">
<area href="classXPathExecutionContext.html" shape="rect" coords="298,234,450,210">
<area href="classMutableNodeRefList.html" shape="rect" coords="500,234,633,210">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXNodeSet-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XPathExecutionContext::BorrowReturnMutableNodeRefList <a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXNodeSet.html#a0">XNodeSet</a> (<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp;value, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<dl class="el"><dd><font size=-1><em>Create an XNodeSet from a node list.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXNodeSet.html#a1">XNodeSet</a> (const XNodeSet &amp;source, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, bool deepClone=false)
<dl class="el"><dd><font size=-1><em>Create an XNodeSet from another.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXNodeSet.html#a2">~XNodeSet</a> ()
<li>virtual const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a>&amp; <a class="el" href="classXNodeSet.html#a3">nodeset</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a nodelist.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanNode.html">XalanNode</a>* <a class="el" href="classXNodeSet.html#a4">item</a> (<a class="el" href="classXNodeSetBase.html#s0">size_type</a> index) const
<li>virtual <a class="el" href="classXNodeSetBase.html#s0">size_type</a> <a class="el" href="classXNodeSet.html#a5">getLength</a> () const
<li>void <a class="el" href="classXNodeSet.html#a6">release</a> ()
<dl class="el"><dd><font size=-1><em>Release the node set held by the instance.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXNodeSet.html#a7">set</a> (<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp;value)
<dl class="el"><dd><font size=-1><em>Change the value of an XNodeSet.</em> <a href="#a7">More...</a><em><br><br></em></font></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to hold <a class="el" href="classXPath.html">XPath</a> return types.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XNodeSet::BorrowReturnMutableNodeRefList"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XPathExecutionContext::BorrowReturnMutableNodeRefList XNodeSet::BorrowReturnMutableNodeRefList
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XNodeSet::XNodeSet"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNodeSet::XNodeSet (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp; <em>value</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create an XNodeSet from a node list.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>value</em>
&nbsp;</td><td>
Pointer to source node list. The XNodeSet will adopt the pointer. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="XNodeSet::XNodeSet"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNodeSet::XNodeSet (
</b></td>
<td valign="bottom"><b>
const XNodeSet &amp; <em>source</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>deepClone</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create an XNodeSet from another.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em>
&nbsp;</td><td>
object to copy </td></tr>
<tr><td valign=top><em>deepClone</em>
&nbsp;</td><td>
true to copy all children on nodeset nodes </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="XNodeSet::~XNodeSet"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XNodeSet::~XNodeSet (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="XNodeSet::getLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXNodeSetBase.html#s0">size_type</a> XNodeSet::getLength (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classXNodeSetBase.html#a14">XNodeSetBase</a>. </td>
</tr>
</table>
<a name="a4" doxytag="XNodeSet::item"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanNode.html">XalanNode</a> * XNodeSet::item (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXNodeSetBase.html#s0">size_type</a> <em>index</em>&nbsp;) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classXNodeSetBase.html#a13">XNodeSetBase</a>. </td>
</tr>
</table>
<a name="a3" doxytag="XNodeSet::nodeset"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp; XNodeSet::nodeset (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cast result object to a nodelist.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
node list </dl>
<p>
Reimplemented from <a class="el" href="classXNodeSetBase.html#a10">XNodeSetBase</a>. </td>
</tr>
</table>
<a name="a6" doxytag="XNodeSet::release"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNodeSet::release (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Release the node set held by the instance.
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="XNodeSet::set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XNodeSet::set (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp; <em>value</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Change the value of an XNodeSet.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theValue</em>
&nbsp;</td><td>
The new value. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<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></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>