Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classNodeNameTreeWalker.html
blob: 71a28bd925b355dda4b1c65e7d77254153f8edda [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> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>NodeNameTreeWalker Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="NodeNameTreeWalker" --><!-- doxytag: inherits="TreeWalker" -->
<p><code>#include &lt;<a class="el" href="NodeNameTreeWalker_8hpp_source.html">NodeNameTreeWalker.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classTreeWalker.html">TreeWalker</a>.</p>
<div class="dynheader">
Collaboration diagram for NodeNameTreeWalker:</div>
<div class="dyncontent">
<div class="center"><img src="classNodeNameTreeWalker__coll__graph.png" border="0" usemap="#NodeNameTreeWalker_coll__map" alt="Collaboration graph"/></div>
<map name="NodeNameTreeWalker_coll__map" id="NodeNameTreeWalker_coll__map">
<area shape="rect" id="node2" href="classTreeWalker.html" title="TreeWalker" alt="" coords="5,101,96,131"/><area shape="rect" id="node4" href="classXalanVector.html" title="XalanVector\&lt; const XalanNode * \&gt;" alt="" coords="120,101,371,131"/><area shape="rect" id="node6" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="395,101,523,131"/><area shape="rect" id="node8" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="345,5,572,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classNodeNameTreeWalker-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt; const <br class="typebreak"/>
<a class="el" href="classXalanNode.html">XalanNode</a> * &gt; <a class="el" href="classNodeNameTreeWalker.html#a1b84244bdb29f6029339021a99ff0998">NodeVectorType</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classNodeNameTreeWalker.html#afd2e7681f93f2e1f930973a216b02e93">NodeNameTreeWalker</a> (MemoryManager &amp;theManager)
<li>virtual <a class="el" href="classNodeNameTreeWalker.html#a1e2121f500aae061ff7627ce9a19759a">~NodeNameTreeWalker</a> ()
<li>virtual void <a class="el" href="classNodeNameTreeWalker.html#acdbfe805031ff0048eb581c623a7efde">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 class="mdescRight">Find all nodes matching a specified node in a specified node tree. <a href="#acdbfe805031ff0048eb581c623a7efde"></a><br/></dl><li>virtual void <a class="el" href="classNodeNameTreeWalker.html#af83c115d47f168466cffbd5763feb910">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="classXalanVector.html">NodeVectorType</a> &amp; <a class="el" href="classNodeNameTreeWalker.html#a72da01bd0bca8d74af4f7ac69d4097de">getMatchingNodes</a> () const
<dl class="el"><dd class="mdescRight">Retrieve the matching nodes from the last search. <a href="#a72da01bd0bca8d74af4f7ac69d4097de"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#a9286b3b37cf08ac2f9c2fd0820f36e1d">startNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when first walking a node. <a href="#a9286b3b37cf08ac2f9c2fd0820f36e1d"></a><br/></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#a44e0dac363b60071cb44433fd8efeff9">endNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when leaving a node. <a href="#a44e0dac363b60071cb44433fd8efeff9"></a><br/></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#abb912f29dfec1a3912d7196bc96ef7cf">startNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when first walking a node. <a href="#abb912f29dfec1a3912d7196bc96ef7cf"></a><br/></dl><li>virtual bool <a class="el" href="classNodeNameTreeWalker.html#a95f6e440673b78124919d29c39af732c">endNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when leaving a node. <a href="#a95f6e440673b78124919d29c39af732c"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="NodeNameTreeWalker_8hpp_source.html#l00039">39</a> of file <a class="el" href="NodeNameTreeWalker_8hpp_source.html">NodeNameTreeWalker.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a1b84244bdb29f6029339021a99ff0998"></a><!-- doxytag: member="NodeNameTreeWalker::NodeVectorType" ref="a1b84244bdb29f6029339021a99ff0998" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;const <a class="el" href="classXalanNode.html">XalanNode</a>*&gt; <a class="el" href="classXalanVector.html">NodeNameTreeWalker::NodeVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeNameTreeWalker_8hpp_source.html#l00043">43</a> of file <a class="el" href="NodeNameTreeWalker_8hpp_source.html">NodeNameTreeWalker.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afd2e7681f93f2e1f930973a216b02e93"></a><!-- doxytag: member="NodeNameTreeWalker::NodeNameTreeWalker" ref="afd2e7681f93f2e1f930973a216b02e93" args="(MemoryManager &amp;theManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeNameTreeWalker::NodeNameTreeWalker </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e2121f500aae061ff7627ce9a19759a"></a><!-- doxytag: member="NodeNameTreeWalker::~NodeNameTreeWalker" ref="a1e2121f500aae061ff7627ce9a19759a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual NodeNameTreeWalker::~NodeNameTreeWalker </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="a44e0dac363b60071cb44433fd8efeff9"></a><!-- doxytag: member="NodeNameTreeWalker::endNode" ref="a44e0dac363b60071cb44433fd8efeff9" args="(XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NodeNameTreeWalker::endNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when leaving a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#ab5c73e0bdffba1abae8b9572d203c6e4">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="a95f6e440673b78124919d29c39af732c"></a><!-- doxytag: member="NodeNameTreeWalker::endNode" ref="a95f6e440673b78124919d29c39af732c" args="(const XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NodeNameTreeWalker::endNode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when leaving a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a1c7ccec81444662d68ba4ce315fffdc4">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="acdbfe805031ff0048eb581c623a7efde"></a><!-- doxytag: member="NodeNameTreeWalker::findMatchingNodes" ref="acdbfe805031ff0048eb581c623a7efde" args="(const XalanDOMString &amp;theNodeName, const XalanNode *theStartNode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void NodeNameTreeWalker::findMatchingNodes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theNodeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>theStartNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find all nodes matching a specified node in a specified node tree. </p>
<p>The member m_matchingNodes is populated as a side effect.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theNodeName</em>&nbsp;</td><td>name of node sought </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theStartNode</em>&nbsp;</td><td>start node for search </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af83c115d47f168466cffbd5763feb910"></a><!-- doxytag: member="NodeNameTreeWalker::findMatchingNodes" ref="af83c115d47f168466cffbd5763feb910" args="(const XalanDOMString &amp;theNodeName, XalanNode *theStartNode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void NodeNameTreeWalker::findMatchingNodes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theNodeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>theStartNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a72da01bd0bca8d74af4f7ac69d4097de"></a><!-- doxytag: member="NodeNameTreeWalker::getMatchingNodes" ref="a72da01bd0bca8d74af4f7ac69d4097de" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanVector.html">NodeVectorType</a>&amp; NodeNameTreeWalker::getMatchingNodes </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the matching nodes from the last search. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>vector of nodes </dd></dl>
<p>Definition at line <a class="el" href="NodeNameTreeWalker_8hpp_source.html#l00073">73</a> of file <a class="el" href="NodeNameTreeWalker_8hpp_source.html">NodeNameTreeWalker.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9286b3b37cf08ac2f9c2fd0820f36e1d"></a><!-- doxytag: member="NodeNameTreeWalker::startNode" ref="a9286b3b37cf08ac2f9c2fd0820f36e1d" args="(XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NodeNameTreeWalker::startNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when first walking a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a8b397b497b075c49a1adb4ecf6670f50">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="abb912f29dfec1a3912d7196bc96ef7cf"></a><!-- doxytag: member="NodeNameTreeWalker::startNode" ref="abb912f29dfec1a3912d7196bc96ef7cf" args="(const XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NodeNameTreeWalker::startNode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when first walking a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a0830d7c43de92c10554775dbcd59526b">TreeWalker</a>.</p>
</div>
</div>
<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></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>