Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / structNodeSorter_1_1NodeSortKeyCompare.html
blob: ee7dfa28acebbd3c50a396318eb249ce32ed857a [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 class="navpath">
<ul>
<li><a class="el" href="classNodeSorter.html">NodeSorter</a> </li>
<li><a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html">NodeSorter::NodeSortKeyCompare</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>NodeSorter::NodeSortKeyCompare Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="NodeSorter::NodeSortKeyCompare" -->
<p>Return the results of a compare of two nodes.
<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::NodeSortKeyCompare:</div>
<div class="dyncontent">
<div class="center"><img src="structNodeSorter_1_1NodeSortKeyCompare__coll__graph.png" border="0" usemap="#NodeSorter_1_1NodeSortKeyCompare_coll__map" alt="Collaboration graph"/></div>
<map name="NodeSorter_1_1NodeSortKeyCompare_coll__map" id="NodeSorter_1_1NodeSortKeyCompare_coll__map">
<area shape="rect" id="node2" href="classNodeSorter.html" title="This class can sort vectors of nodes according to a select pattern." alt="" coords="365,296,461,325"/><area shape="rect" id="node4" href="classXalanVector.html" title="XalanVector\&lt; NodeSortKey \&gt;" alt="" coords="539,181,752,211"/><area shape="rect" id="node6" href="classXalanVector.html" title="XalanVector\&lt; Type, ConstructionTraits \&gt;" alt="" coords="5,181,288,211"/><area shape="rect" id="node8" href="classXalanVector.html" title="XalanVector\&lt; VectorEntry \&gt;" alt="" coords="312,181,515,211"/><area shape="rect" id="node11" href="classStylesheetExecutionContext.html" title="StylesheetExecutionContext" alt="" coords="585,296,788,325"/><area shape="rect" id="node13" href="classXPathExecutionContext.html" title="XPathExecutionContext" alt="" coords="776,181,949,211"/><area shape="rect" id="node15" href="classExecutionContext.html" title="ExecutionContext" alt="" coords="695,85,828,115"/><area shape="rect" id="node17" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="683,5,840,35"/><area shape="rect" id="node19" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="852,85,969,115"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="structNodeSorter_1_1NodeSortKeyCompare-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html#a24607317b8df3878bbe93445379300af">NodeSortKeyCompare</a> (<a class="el" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a> &amp;executionContext, <a class="el" href="classNodeSorter.html">NodeSorter</a> &amp;theSorter, const <a class="el" href="classXalanVector.html">NodeVectorType</a> &amp;theNodes, const <a class="el" href="classXalanVector.html">NodeSortKeyVectorType</a> &amp;theNodeSortKeys)
<dl class="el"><dd class="mdescRight">Construct a <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html" title="Return the results of a compare of two nodes.">NodeSortKeyCompare</a> object, to perform the sort. <a href="#a24607317b8df3878bbe93445379300af"></a><br/></dl><li>int <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html#a32cb31e246ece23e652830d77317aec9">compare</a> (first_argument_type theLHS, second_argument_type theRHS, XalanSize_t theKeyIndex=0) const
<dl class="el"><dd class="mdescRight">Compare two nodes, returning a value to indicate the result. <a href="#a32cb31e246ece23e652830d77317aec9"></a><br/></dl><li>result_type <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html#a2f418dc86692ebc99508fff28bff93c5">operator()</a> (first_argument_type theLHS, second_argument_type theRHS, XalanSize_t theKeyIndex=0) const
<dl class="el"><dd class="mdescRight">Compare two nodes as a less predicate. <a href="#a2f418dc86692ebc99508fff28bff93c5"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>double <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html#ae41ffd138da4a44994e82abfa107385c">getNumberResult</a> (const <a class="el" href="classNodeSortKey.html">NodeSortKey</a> &amp;theKey, XalanSize_t theKeyIndex, first_argument_type theEntry) const
<li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html#a7d62e93edaca4c07fff20df466935e27">getStringResult</a> (const <a class="el" href="classNodeSortKey.html">NodeSortKey</a> &amp;theKey, XalanSize_t theKeyIndex, first_argument_type theEntry) const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Return the results of a compare of two nodes. </p>
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00114">114</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a24607317b8df3878bbe93445379300af"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare::NodeSortKeyCompare" ref="a24607317b8df3878bbe93445379300af" args="(StylesheetExecutionContext &amp;executionContext, NodeSorter &amp;theSorter, const NodeVectorType &amp;theNodes, const NodeSortKeyVectorType &amp;theNodeSortKeys)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeSorter::NodeSortKeyCompare::NodeSortKeyCompare </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="classNodeSorter.html">NodeSorter</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSorter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanVector.html">NodeVectorType</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theNodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanVector.html">NodeSortKeyVectorType</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theNodeSortKeys</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="structNodeSorter_1_1NodeSortKeyCompare.html" title="Return the results of a compare of two nodes.">NodeSortKeyCompare</a> object, to perform the sort. </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>theNodes</em>&nbsp;</td><td>vector or nodes to be sorted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theNodeSortKeys</em>&nbsp;</td><td>vector of keys upon which to sort </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00126">126</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a32cb31e246ece23e652830d77317aec9"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare::compare" ref="a32cb31e246ece23e652830d77317aec9" args="(first_argument_type theLHS, second_argument_type theRHS, XalanSize_t theKeyIndex=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NodeSorter::NodeSortKeyCompare::compare </td>
<td>(</td>
<td class="paramtype">first_argument_type&nbsp;</td>
<td class="paramname"> <em>theLHS</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">second_argument_type&nbsp;</td>
<td class="paramname"> <em>theRHS</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanSize_t&nbsp;</td>
<td class="paramname"> <em>theKeyIndex</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare two nodes, returning a value to indicate the result. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theLHS</em>&nbsp;</td><td>the first node to compare </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theRHS</em>&nbsp;</td><td>the second node to compare </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theKeyIndex</em>&nbsp;</td><td>the index of the key to use </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>&lt; 0 if theLHS is less than theRHS, 0 if they are equal, and &gt; 0 if theLHS is greater than theRHS </dd></dl>
</div>
</div>
<a class="anchor" id="ae41ffd138da4a44994e82abfa107385c"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare::getNumberResult" ref="ae41ffd138da4a44994e82abfa107385c" args="(const NodeSortKey &amp;theKey, XalanSize_t theKeyIndex, first_argument_type theEntry) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double NodeSorter::NodeSortKeyCompare::getNumberResult </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNodeSortKey.html">NodeSortKey</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanSize_t&nbsp;</td>
<td class="paramname"> <em>theKeyIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">first_argument_type&nbsp;</td>
<td class="paramname"> <em>theEntry</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d62e93edaca4c07fff20df466935e27"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare::getStringResult" ref="a7d62e93edaca4c07fff20df466935e27" args="(const NodeSortKey &amp;theKey, XalanSize_t theKeyIndex, first_argument_type theEntry) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; NodeSorter::NodeSortKeyCompare::getStringResult </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNodeSortKey.html">NodeSortKey</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanSize_t&nbsp;</td>
<td class="paramname"> <em>theKeyIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">first_argument_type&nbsp;</td>
<td class="paramname"> <em>theEntry</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2f418dc86692ebc99508fff28bff93c5"></a><!-- doxytag: member="NodeSorter::NodeSortKeyCompare::operator()" ref="a2f418dc86692ebc99508fff28bff93c5" args="(first_argument_type theLHS, second_argument_type theRHS, XalanSize_t theKeyIndex=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">result_type NodeSorter::NodeSortKeyCompare::operator() </td>
<td>(</td>
<td class="paramtype">first_argument_type&nbsp;</td>
<td class="paramname"> <em>theLHS</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">second_argument_type&nbsp;</td>
<td class="paramname"> <em>theRHS</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanSize_t&nbsp;</td>
<td class="paramname"> <em>theKeyIndex</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare two nodes as a less predicate. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theLHS</em>&nbsp;</td><td>the first node to compare </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theRHS</em>&nbsp;</td><td>the second node to compare </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theKeyIndex</em>&nbsp;</td><td>the index of the key to use </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if theLHS is less than theRHS </dd></dl>
<p>Definition at line <a class="el" href="NodeSorter_8hpp_source.html#l00162">162</a> of file <a class="el" href="NodeSorter_8hpp_source.html">NodeSorter.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct 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>