Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / old / xalan-c / apiDocs / classNodeRefList.html
blob: 8bfd0dfd8af49fa59382fe8997362d38d6623e85 [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>NodeRefList Class Reference</h1>Local implementation of NodeRefList.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="NodeRefList_8hpp-source.html">NodeRefList.hpp</a>&gt;</code>
<p>
Inheritance diagram for NodeRefList:<p><center><img src="classNodeRefList__inherit__graph.gif" border="0" usemap="#NodeRefList_inherit_map" alt="Inheritance graph"></center>
<map name="NodeRefList_inherit_map">
<area href="classMutableNodeRefList.html" shape="rect" coords="6,192,140,168">
<area href="classNodeRefListBase.html" shape="rect" coords="16,42,130,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NodeRefList:<p><center><img src="classNodeRefList__coll__graph.gif" border="0" usemap="#NodeRefList_coll_map" alt="Collaboration graph"></center>
<map name="NodeRefList_coll_map">
<area href="classNodeRefListBase.html" shape="rect" coords="6,42,121,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classNodeRefList-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XalanVector&lt;<a class="el" href="classXalanNode.html">XalanNode</a>*&gt; <a class="el" href="classNodeRefList.html#s0">NodeListVectorType</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classNodeRefList.html#a0">NodeRefList</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR)
<li><a class="el" href="classNodeRefList.html#a1">NodeRefList</a> (const NodeRefList &amp;theSource, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR)
<dl class="el"><dd><font size=-1><em>Construct a node list from another.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a>&amp; <a class="el" href="classNodeRefList.html#a2">getMemoryManager</a> ()
<li><a class="el" href="classNodeRefList.html#a3">NodeRefList</a> (const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;theSource, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR)
<dl class="el"><dd><font size=-1><em>Construct a node list from another.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classNodeRefList.html#a4">~NodeRefList</a> ()
<li>NodeRefList&amp; <a class="el" href="classNodeRefList.html#a5">operator=</a> (const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;theRHS)
<li>NodeRefList&amp; <a class="el" href="classNodeRefList.html#a6">operator=</a> (const NodeRefList &amp;theRHS)
<li>bool <a class="el" href="classNodeRefList.html#a7">empty</a> () const
<li>virtual <a class="el" href="classXalanNode.html">XalanNode</a>* <a class="el" href="classNodeRefList.html#a8">item</a> (<a class="el" href="classNodeRefListBase.html#s0">size_type</a> index) const
<dl class="el"><dd><font size=-1><em>Returns the <code>index</code>th item in the collection.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classNodeRefListBase.html#s0">size_type</a> <a class="el" href="classNodeRefList.html#a9">getLength</a> () const
<dl class="el"><dd><font size=-1><em>Determine the number of nodes in the list.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classNodeRefListBase.html#s0">size_type</a> <a class="el" href="classNodeRefList.html#a10">indexOf</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *theNode) const
<dl class="el"><dd><font size=-1><em>Retrieve the zero based index of the node in the list.</em> <a href="#a10">More...</a><em><br><br></em></font></dl><li>bool <a class="el" href="classNodeRefList.html#a11">checkForDuplicates</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager) const
<li>void <a class="el" href="classNodeRefList.html#a12">swap</a> (NodeRefList &amp;theOther)
</ul>
<h2>Protected Types</h2>
<ul>
<li>enum { <a class="el" href="classNodeRefList.html#t1t0">eDefaultVectorSize</a> = 100
}
</ul>
<h2>Protected Methods</h2>
<ul>
<li>void <a class="el" href="classNodeRefList.html#b0">ensureAllocation</a> (<a class="el" href="XalanMap_8hpp.html#a1">NodeListVectorType::size_type</a> theSize=0)
<dl class="el"><dd><font size=-1><em>Ensure that an allocation is either the default allocation amount, or the amount specified in the parameter, whichever is larger.</em> <a href="#b0">More...</a><em><br><br></em></font></dl></ul>
<h2>Protected Attributes</h2>
<ul>
<li><a class="el" href="classNodeRefList.html#s0">NodeListVectorType</a> <a class="el" href="classNodeRefList.html#n0">m_nodeList</a>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Local implementation of NodeRefList.
<p>
This class is for internal use only.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="NodeRefList::NodeListVectorType"></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 XalanVector&lt; <a class="el" href="classXalanNode.html">XalanNode</a> *&gt; NodeRefList::NodeListVectorType&lt;<a class="el" href="classXalanNode.html">XalanNode</a>*&gt;
</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 Enumeration Documentation</h2>
<a name="t1" doxytag="NodeRefList::@27"></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>
anonymous enum<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="t1t0" doxytag="eDefaultVectorSize"></a><em>eDefaultVectorSize</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="NodeRefList::NodeRefList"></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>
NodeRefList::NodeRefList (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager <em>XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR</em>&nbsp;)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="NodeRefList::NodeRefList"></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>
NodeRefList::NodeRefList (
</b></td>
<td valign="bottom"><b>
const NodeRefList &amp; <em>theSource</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager <em>XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a node list from another.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSource</em>
&nbsp;</td><td>
source node list </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="NodeRefList::NodeRefList"></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>
NodeRefList::NodeRefList (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp; <em>theSource</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager <em>XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR</em>&nbsp;)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a node list from another.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSource</em>
&nbsp;</td><td>
source node list </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="NodeRefList::~NodeRefList"></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>
NodeRefList::~NodeRefList (
</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="a11" doxytag="NodeRefList::checkForDuplicates"></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>
bool NodeRefList::checkForDuplicates (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="NodeRefList::empty"></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>
bool NodeRefList::empty (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b0" doxytag="NodeRefList::ensureAllocation"></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 NodeRefList::ensureAllocation (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMap_8hpp.html#a1">NodeListVectorType::size_type</a> <em>theSize</em> = 0&nbsp;)<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Ensure that an allocation is either the default allocation amount, or the amount specified in the parameter, whichever is larger.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSize</em>
&nbsp;</td><td>
The requested size. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a9" doxytag="NodeRefList::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="classNodeRefListBase.html#s0">size_type</a> NodeRefList::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>
Determine the number of nodes in the list.
<p>
The range of valid child node indices is 0 to <code>length-1</code> inclusive.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
number of nodes </dl>
<p>
Reimplemented from <a class="el" href="classNodeRefListBase.html#a3">NodeRefListBase</a>. </td>
</tr>
</table>
<a name="a2" doxytag="NodeRefList::getMemoryManager"></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="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; NodeRefList::getMemoryManager (
</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>
</td>
</tr>
</table>
<a name="a10" doxytag="NodeRefList::indexOf"></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="classNodeRefListBase.html#s0">size_type</a> NodeRefList::indexOf (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>theNode</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>
Retrieve the zero based index of the node in the list.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theNode</em>
&nbsp;</td><td>
node whose index to find </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
index of node </dl>
<p>
Reimplemented from <a class="el" href="classNodeRefListBase.html#a4">NodeRefListBase</a>. </td>
</tr>
</table>
<a name="a8" doxytag="NodeRefList::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> * NodeRefList::item (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classNodeRefListBase.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>
Returns the <code>index</code>th item in the collection.
<p>
If <code>index</code> is greater than or equal to the number of nodes in the list, this returns <code>null</code>.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>index</em>
&nbsp;</td><td>
index into the collection </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
node at the <code>index</code>th position in the <code>NodeList</code>, or <code>null</code> if that is not a valid index </dl>
<p>
Reimplemented from <a class="el" href="classNodeRefListBase.html#a2">NodeRefListBase</a>. </td>
</tr>
</table>
<a name="a6" doxytag="NodeRefList::operator="></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>
NodeRefList &amp; NodeRefList::operator= (
</b></td>
<td valign="bottom"><b>
const NodeRefList &amp; <em>theRHS</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classMutableNodeRefList.html#a5">MutableNodeRefList</a>. </td>
</tr>
</table>
<a name="a5" doxytag="NodeRefList::operator="></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>
NodeRefList &amp; NodeRefList::operator= (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp; <em>theRHS</em>&nbsp;)
</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="classNodeRefListBase.html#b1">NodeRefListBase</a>.
<p>
Reimplemented in <a class="el" href="classMutableNodeRefList.html#a6">MutableNodeRefList</a>. </td>
</tr>
</table>
<a name="a12" doxytag="NodeRefList::swap"></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 NodeRefList::swap (
</b></td>
<td valign="bottom"><b>
NodeRefList &amp; <em>theOther</em>&nbsp;)
</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 Data Documentation</h2>
<a name="n0" doxytag="NodeRefList::m_nodeList"></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="classNodeRefList.html#s0">NodeListVectorType</a> NodeRefList::m_nodeList<code> [protected]</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>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="NodeRefList_8hpp-source.html">NodeRefList.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>