blob: 0295126bdd53b15fe437980bed95e8857ef93f7f [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>NodeNameTreeWalker Class Reference</h1><code>#include &lt;<a class="el" href="NodeNameTreeWalker_8hpp-source.html">NodeNameTreeWalker.hpp</a>&gt;</code>
<p>
Inheritance diagram for NodeNameTreeWalker:<p><center><img src="classNodeNameTreeWalker__inherit__graph.gif" border="0" usemap="#NodeNameTreeWalker_inherit_map" alt="Inheritance graph"></center>
<map name="NodeNameTreeWalker_inherit_map">
<area href="classTreeWalker.html" shape="rect" coords="37,42,125,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NodeNameTreeWalker:<p><center><img src="classNodeNameTreeWalker__coll__graph.gif" border="0" usemap="#NodeNameTreeWalker_coll_map" alt="Collaboration graph"></center>
<map name="NodeNameTreeWalker_coll_map">
<area href="classTreeWalker.html" shape="rect" coords="6,42,94,18">
<area href="classXalanDOMString.html" shape="rect" coords="118,42,235,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classNodeNameTreeWalker-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XalanVector&lt;const <br>
<a class="el" href="classXalanNode.html">XalanNode</a>*&gt; <a class="el" href="classNodeNameTreeWalker.html#s0">NodeVectorType</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classNodeNameTreeWalker.html#a0">NodeNameTreeWalker</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<li>virtual <a class="el" href="classNodeNameTreeWalker.html#a1">~NodeNameTreeWalker</a> ()
<li>virtual void <a class="el" href="classNodeNameTreeWalker.html#a2">findMatchingNodes</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theNodeName, const <a class="el" href="classXalanNode.html">XalanNode</a> *theStartNode)
<dl class="el"><dd><font size=-1><em>Find all nodes matching a specified node in a specified node tree.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classNodeNameTreeWalker.html#a3">findMatchingNodes</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theNodeName, <a class="el" href="classXalanNode.html">XalanNode</a> *theStartNode)
<li>const <a class="el" href="classNodeNameTreeWalker.html#s0">NodeVectorType</a>&amp; <a class="el" href="classNodeNameTreeWalker.html#a4">getMatchingNodes</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve the matching nodes from the last search.</em> <a href="#a4">More...</a><em><br><br></em></font></dl></ul>
<h2>Protected Methods</h2>
<ul>
<li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#b0">startNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd><font size=-1><em>Called when first walking a node.</em> <a href="#b0">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#b1">endNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd><font size=-1><em>Called when leaving a node.</em> <a href="#b1">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#b2">startNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd><font size=-1><em>Called when first walking a node.</em> <a href="#b2">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#b3">endNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd><font size=-1><em>Called when leaving a node.</em> <a href="#b3">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="NodeNameTreeWalker::NodeVectorType"></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; const <a class="el" href="classXalanNode.html">XalanNode</a> *&gt; NodeNameTreeWalker::NodeVectorType&lt;const <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>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="NodeNameTreeWalker::NodeNameTreeWalker"></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>
NodeNameTreeWalker::NodeNameTreeWalker (
</b></td>
<td valign="bottom"><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>
</td>
</tr>
</table>
<a name="a1" doxytag="NodeNameTreeWalker::~NodeNameTreeWalker"></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>
NodeNameTreeWalker::~NodeNameTreeWalker (
</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="b3" doxytag="NodeNameTreeWalker::endNode"></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 NodeNameTreeWalker::endNode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when leaving a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if the walk should continue, or true if it should not. </dl>
<p>
Reimplemented from <a class="el" href="classTreeWalker.html#b2">TreeWalker</a>. </td>
</tr>
</table>
<a name="b1" doxytag="NodeNameTreeWalker::endNode"></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 NodeNameTreeWalker::endNode (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanNode.html">XalanNode</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when leaving a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if the walk should continue, or true if it should not. </dl>
<p>
Reimplemented from <a class="el" href="classTreeWalker.html#b3">TreeWalker</a>. </td>
</tr>
</table>
<a name="a3" doxytag="NodeNameTreeWalker::findMatchingNodes"></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 NodeNameTreeWalker::findMatchingNodes (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theNodeName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanNode.html">XalanNode</a> * <em>theStartNode</em>&nbsp;)<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>
<a name="a2" doxytag="NodeNameTreeWalker::findMatchingNodes"></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 NodeNameTreeWalker::findMatchingNodes (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theNodeName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>theStartNode</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find all nodes matching a specified node in a specified node tree.
<p>
The member m_matchingNodes is populated as a side effect.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theNodeName</em>
&nbsp;</td><td>
name of node sought </td></tr>
<tr><td valign=top><em>theStartNode</em>
&nbsp;</td><td>
start node for search </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="NodeNameTreeWalker::getMatchingNodes"></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="classNodeNameTreeWalker.html#s0">NodeVectorType</a> &amp; NodeNameTreeWalker::getMatchingNodes (
</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>
Retrieve the matching nodes from the last search.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
vector of nodes </dl> </td>
</tr>
</table>
<a name="b2" doxytag="NodeNameTreeWalker::startNode"></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 NodeNameTreeWalker::startNode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when first walking a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if the walk should continue, or true if it should not. </dl>
<p>
Reimplemented from <a class="el" href="classTreeWalker.html#b0">TreeWalker</a>. </td>
</tr>
</table>
<a name="b0" doxytag="NodeNameTreeWalker::startNode"></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 NodeNameTreeWalker::startNode (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanNode.html">XalanNode</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when first walking a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if the walk should continue, or true if it should not. </dl>
<p>
Reimplemented from <a class="el" href="classTreeWalker.html#b1">TreeWalker</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="NodeNameTreeWalker_8hpp-source.html">NodeNameTreeWalker.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>