Google Git
Sign in
apache / xalan-site / fc63e1a05362d8a54765634eed15aec345e1ef1d / . / content / old / xalan-c / apiDocs / classNodeSortKey.html
blob: df6e8f5c7876eb9edbfcbe6d2b7e40057b610945 [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>NodeSortKey Class Reference</h1>Simple data structure class for use by the NodeSorter class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="NodeSortKey_8hpp-source.html">NodeSortKey.hpp</a>&gt;</code>
<p>
Collaboration diagram for NodeSortKey:<p><center><img src="classNodeSortKey__coll__graph.gif" border="0" usemap="#NodeSortKey_coll_map" alt="Collaboration graph"></center>
<map name="NodeSortKey_coll_map">
<area href="classExecutionContext.html" shape="rect" coords="7,237,124,213">
<area href="classPrefixResolver.html" shape="rect" coords="175,237,276,213">
<area href="classXalanDOMString.html" shape="rect" coords="323,146,440,122">
<area href="classXPath.html" shape="rect" coords="489,237,542,213">
<area href="classXPathFunctionTable.html" shape="rect" coords="485,146,618,122">
<area href="classFunction.html" shape="rect" coords="418,42,485,18">
<area href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" shape="rect" coords="509,42,794,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classNodeSortKey-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classNodeSortKey.html#a0">NodeSortKey</a> (<a class="el" href="classExecutionContext.html">ExecutionContext</a> &amp;executionContext, const <a class="el" href="classXPath.html">XPath</a> *selectPat, bool treatAsNumbers, bool descending, <a class="el" href="classXalanCollationServices.html#s3">XalanCollationServices::eCaseOrder</a> caseOrder, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;langValue, const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp;resolver)
<dl class="el"><dd><font size=-1><em>Construct a node sort key.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classNodeSortKey.html#a1">NodeSortKey</a> ()
<li><a class="el" href="classNodeSortKey.html#a2">NodeSortKey</a> (const NodeSortKey &amp;theSource)
<li><a class="el" href="classNodeSortKey.html#a3">~NodeSortKey</a> ()
<li>NodeSortKey&amp; <a class="el" href="classNodeSortKey.html#a4">operator=</a> (const NodeSortKey &amp;theRHS)
<li>const <a class="el" href="classXPath.html">XPath</a>* <a class="el" href="classNodeSortKey.html#a5">getSelectPattern</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve the selection <a class="el" href="classXPath.html">XPath</a>.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>bool <a class="el" href="classNodeSortKey.html#a6">getTreatAsNumbers</a> () const
<dl class="el"><dd><font size=-1><em>Whether to treat values as numbers.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>bool <a class="el" href="classNodeSortKey.html#a7">getDescending</a> () const
<dl class="el"><dd><font size=-1><em>Whether to sort in descending order.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXalanCollationServices.html#s3">XalanCollationServices::eCaseOrder</a> <a class="el" href="classNodeSortKey.html#a8">getCaseOrder</a> () const
<dl class="el"><dd><font size=-1><em>Get the enumeration value for the case order.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classPrefixResolver.html">PrefixResolver</a>* <a class="el" href="classNodeSortKey.html#a9">getPrefixResolver</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve the resolver for namespaces.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classNodeSortKey.html#a10">getLanguageString</a> () const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Simple data structure class for use by the NodeSorter class.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="NodeSortKey::NodeSortKey"></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>
NodeSortKey::NodeSortKey (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classExecutionContext.html">ExecutionContext</a> &amp; <em>executionContext</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPath.html">XPath</a> * <em>selectPat</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>treatAsNumbers</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>descending</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanCollationServices.html#s3">XalanCollationServices::eCaseOrder</a> <em>caseOrder</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>langValue</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classPrefixResolver.html">PrefixResolver</a> &amp; <em>resolver</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 sort key.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>executionContext</em>
&nbsp;</td><td>
current execution context </td></tr>
<tr><td valign=top><em>selectPat</em>
&nbsp;</td><td>
<a class="el" href="classXPath.html">XPath</a> for selection </td></tr>
<tr><td valign=top><em>treatAsNumbers</em>
&nbsp;</td><td>
treat as numeric values if true </td></tr>
<tr><td valign=top><em>descending</em>
&nbsp;</td><td>
sort in descending order if true </td></tr>
<tr><td valign=top><em>caseOrder</em>
&nbsp;</td><td>
case sort order enum </td></tr>
<tr><td valign=top><em>langValue</em>
&nbsp;</td><td>
language </td></tr>
<tr><td valign=top><em>resolver</em>
&nbsp;</td><td>
resolver for namespace resolution </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="NodeSortKey::NodeSortKey"></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>
NodeSortKey::NodeSortKey (
</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="a2" doxytag="NodeSortKey::NodeSortKey"></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>
NodeSortKey::NodeSortKey (
</b></td>
<td valign="bottom"><b>
const NodeSortKey &amp; <em>theSource</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="a3" doxytag="NodeSortKey::~NodeSortKey"></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>
NodeSortKey::~NodeSortKey (
</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>
<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="NodeSortKey::getCaseOrder"></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="classXalanCollationServices.html#s3">XalanCollationServices::eCaseOrder</a> NodeSortKey::getCaseOrder (
</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>
Get the enumeration value for the case order.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
sort upper case before lower case if true </dl> </td>
</tr>
</table>
<a name="a7" doxytag="NodeSortKey::getDescending"></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 NodeSortKey::getDescending (
</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>
Whether to sort in descending order.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
sort in descending order if true </dl> </td>
</tr>
</table>
<a name="a10" doxytag="NodeSortKey::getLanguageString"></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="classXalanDOMString.html">XalanDOMString</a> &amp; NodeSortKey::getLanguageString (
</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="a9" doxytag="NodeSortKey::getPrefixResolver"></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="classPrefixResolver.html">PrefixResolver</a> * NodeSortKey::getPrefixResolver (
</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 resolver for namespaces.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
object for namespace resolution </dl> </td>
</tr>
</table>
<a name="a5" doxytag="NodeSortKey::getSelectPattern"></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="classXPath.html">XPath</a> * NodeSortKey::getSelectPattern (
</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 selection <a class="el" href="classXPath.html">XPath</a>.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
<a class="el" href="classXPath.html">XPath</a> for selection </dl> </td>
</tr>
</table>
<a name="a6" doxytag="NodeSortKey::getTreatAsNumbers"></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 NodeSortKey::getTreatAsNumbers (
</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>
Whether to treat values as numbers.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
treat as numeric values if true </dl> </td>
</tr>
</table>
<a name="a4" doxytag="NodeSortKey::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>
NodeSortKey &amp; NodeSortKey::operator= (
</b></td>
<td valign="bottom"><b>
const NodeSortKey &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>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="NodeSortKey_8hpp-source.html">NodeSortKey.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>