Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classNodeSorter.html
blob: 7a84cace0743b8e72fc0ac4dea592ae695351f7b [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="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>NodeSorter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="NodeSorter" -->
<p>This class can sort vectors of nodes according to a select pattern.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for NodeSorter:</div>
<div class="dyncontent">
<div class="center"><img src="classNodeSorter__coll__graph.png" border="0" usemap="#NodeSorter_coll__map" alt="Collaboration graph"/></div>
<map name="NodeSorter_coll__map" id="NodeSorter_coll__map">
<area shape="rect" id="node2" href="classXalanVector.html" title="XalanVector\&lt; NodeSortKey \&gt;" alt="" coords="40,5,253,35"/><area shape="rect" id="node4" href="classXalanVector.html" title="XalanVector\&lt; Type, ConstructionTraits \&gt;" alt="" coords="5,71,288,100"/><area shape="rect" id="node6" href="classXalanVector.html" title="XalanVector\&lt; VectorEntry \&gt;" alt="" coords="45,124,248,153"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classNodeSorter-members.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>struct <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html">NodeSortKeyCompare</a>
<dl class="el"><dd class="mdescRight">Return the results of a compare of two nodes. <a href="structNodeSorter_1_1NodeSortKeyCompare.html#_details">More...</a><br/></dl><li>struct <a class="el" href="structNodeSorter_1_1VectorEntry.html">VectorEntry</a>
</ul>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt; <a class="el" href="structNodeSorter_1_1VectorEntry.html">VectorEntry</a> &gt; <a class="el" href="classNodeSorter.html#a608833a9c27dd5ce6edd4022c9aca78a">NodeVectorType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt; <a class="el" href="classNodeSortKey.html">NodeSortKey</a> &gt; <a class="el" href="classNodeSorter.html#a62dcb7407e3abc9eadbbd332de06b9ff">NodeSortKeyVectorType</a>
<li>typedef <a class="el" href="classXalanVector.html">NumberVectorTypeDecl</a> <a class="el" href="classNodeSorter.html#af9fbd36529badd4a2d31a4a17fb3dc45">NumberVectorType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt; <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &gt; <a class="el" href="classNodeSorter.html#a9e9a2b0f5c0cbf98c07140074d9841d6">XObjectVectorType</a>
<li>typedef <a class="el" href="classXalanVector.html">StringVectorTypeDecl</a> <a class="el" href="classNodeSorter.html#a0d5291417cb1d1a7b6bb4b9bc6d24d47">StringVectorType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a><br class="typebreak"/>
&lt; <a class="el" href="classXalanVector.html">NumberVectorType</a> &gt; <a class="el" href="classNodeSorter.html#aa4413527ead33c9927c717773edd74dc">NumberCacheType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a><br class="typebreak"/>
&lt; <a class="el" href="classXalanVector.html">XObjectVectorType</a> &gt; <a class="el" href="classNodeSorter.html#a0ba8a25c6d595578991717781a130020">XObjectCacheType</a>
<li>typedef <a class="el" href="classXalanVector.html">XalanVector</a><br class="typebreak"/>
&lt; <a class="el" href="classXalanVector.html">StringVectorType</a> &gt; <a class="el" href="classNodeSorter.html#a514a976d714a8255060069d8c7733a64">StringCacheType</a>
<li>typedef <a class="el" href="classXalanVector.html">NumberCacheType</a> <a class="el" href="classNodeSorter.html#a4ab4d5122140fce636ec9ee18794b1b2">NumberResultsCacheType</a>
<li>typedef <a class="el" href="classXalanVector.html">StringCacheType</a> <a class="el" href="classNodeSorter.html#a16973299563ac081bad950fb53e55700">StringResultsCacheType</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classNodeSorter.html#a3bf356966f96f205152fffcd5054093a">NodeSorter</a> (MemoryManager &amp;theManager)
<li><a class="el" href="classNodeSorter.html#a2e9f6d22087371376c4dc2093e700aef">~NodeSorter</a> ()
<li><a class="el" href="classXalanVector.html">NodeSortKeyVectorType</a> &amp; <a class="el" href="classNodeSorter.html#a842da5ae5dc6e9733d101b40743f5021">getSortKeys</a> ()
<li>void <a class="el" href="classNodeSorter.html#a486249d4bcfab266ccfadff18aa12bab">sort</a> (<a class="el" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a> &amp;executionContext, <a class="el" href="classMutableNodeRefList.html">MutableNodeRefList</a> &amp;theList)
<dl class="el"><dd class="mdescRight">Given a list of nodes, sort each node according to the criteria in the keys. <a href="#a486249d4bcfab266ccfadff18aa12bab"></a><br/></dl></ul>
<h2><a name="friends"></a>
Friends</h2>
<ul>
<li>struct <a class="el" href="classNodeSorter.html#a822e459d0149111be23913c6da505743">NodeSortKeyCompare</a>
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class can sort vectors of nodes according to a select pattern. </p>
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00062">62</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a62dcb7407e3abc9eadbbd332de06b9ff"></a><!-- doxytag: member="NodeSorter::NodeSortKeyVectorType" ref="a62dcb7407e3abc9eadbbd332de06b9ff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="classNodeSortKey.html">NodeSortKey</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::NodeSortKeyVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00083">83</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a608833a9c27dd5ce6edd4022c9aca78a"></a><!-- doxytag: member="NodeSorter::NodeVectorType" ref="a608833a9c27dd5ce6edd4022c9aca78a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="structNodeSorter_1_1VectorEntry.html">VectorEntry</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::NodeVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00082">82</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa4413527ead33c9927c717773edd74dc"></a><!-- doxytag: member="NodeSorter::NumberCacheType" ref="aa4413527ead33c9927c717773edd74dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="classXalanVector.html">NumberVectorType</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::NumberCacheType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00198">198</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4ab4d5122140fce636ec9ee18794b1b2"></a><!-- doxytag: member="NodeSorter::NumberResultsCacheType" ref="a4ab4d5122140fce636ec9ee18794b1b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">NumberCacheType</a> <a class="el" href="classXalanVector.html">NodeSorter::NumberResultsCacheType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00202">202</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af9fbd36529badd4a2d31a4a17fb3dc45"></a><!-- doxytag: member="NodeSorter::NumberVectorType" ref="af9fbd36529badd4a2d31a4a17fb3dc45" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">NumberVectorTypeDecl</a> <a class="el" href="classXalanVector.html">NodeSorter::NumberVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00194">194</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a514a976d714a8255060069d8c7733a64"></a><!-- doxytag: member="NodeSorter::StringCacheType" ref="a514a976d714a8255060069d8c7733a64" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="classXalanVector.html">StringVectorType</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::StringCacheType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00200">200</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a16973299563ac081bad950fb53e55700"></a><!-- doxytag: member="NodeSorter::StringResultsCacheType" ref="a16973299563ac081bad950fb53e55700" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">StringCacheType</a> <a class="el" href="classXalanVector.html">NodeSorter::StringResultsCacheType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00207">207</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0d5291417cb1d1a7b6bb4b9bc6d24d47"></a><!-- doxytag: member="NodeSorter::StringVectorType" ref="a0d5291417cb1d1a7b6bb4b9bc6d24d47" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">StringVectorTypeDecl</a> <a class="el" href="classXalanVector.html">NodeSorter::StringVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00196">196</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0ba8a25c6d595578991717781a130020"></a><!-- doxytag: member="NodeSorter::XObjectCacheType" ref="a0ba8a25c6d595578991717781a130020" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="classXalanVector.html">XObjectVectorType</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::XObjectCacheType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00199">199</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9e9a2b0f5c0cbf98c07140074d9841d6"></a><!-- doxytag: member="NodeSorter::XObjectVectorType" ref="a9e9a2b0f5c0cbf98c07140074d9841d6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanVector.html">XalanVector</a>&lt;<a class="el" href="classXObjectPtr.html">XObjectPtr</a>&gt; <a class="el" href="classXalanVector.html">NodeSorter::XObjectVectorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00195">195</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3bf356966f96f205152fffcd5054093a"></a><!-- doxytag: member="NodeSorter::NodeSorter" ref="a3bf356966f96f205152fffcd5054093a" args="(MemoryManager &amp;theManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeSorter::NodeSorter </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2e9f6d22087371376c4dc2093e700aef"></a><!-- doxytag: member="NodeSorter::~NodeSorter" ref="a2e9f6d22087371376c4dc2093e700aef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeSorter::~NodeSorter </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a842da5ae5dc6e9733d101b40743f5021"></a><!-- doxytag: member="NodeSorter::getSortKeys" ref="a842da5ae5dc6e9733d101b40743f5021" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXalanVector.html">NodeSortKeyVectorType</a>&amp; NodeSorter::getSortKeys </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00091">91</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a486249d4bcfab266ccfadff18aa12bab"></a><!-- doxytag: member="NodeSorter::sort" ref="a486249d4bcfab266ccfadff18aa12bab" args="(StylesheetExecutionContext &amp;executionContext, MutableNodeRefList &amp;theList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NodeSorter::sort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>executionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMutableNodeRefList.html">MutableNodeRefList</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theList</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a list of nodes, sort each node according to the criteria in the keys. </p>
<p>The list is assumed to be in document order.</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>current execution context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>list of Nodes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a822e459d0149111be23913c6da505743"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare" ref="a822e459d0149111be23913c6da505743" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend struct <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html">NodeSortKeyCompare</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00192">192</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.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>