<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.4</h3> </BODY> <!-- Generated by Doxygen 1.1.2 on Mon Sep 16 08:32:16 2002 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>NodeSortKey Class Reference</h1>Simple data structure class for use by the <a class="el" href="class_nodesorter.html">NodeSorter</a> class. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="NodeSortKey.hpp-source.html">NodeSortKey.hpp</a>></code> <p> Collaboration diagram for NodeSortKey:<p><center><img src="class_nodesortkey_coll_graph.gif" border="0" usemap="#NodeSortKey_impl_map"></center> <map name="NodeSortKey_impl_map"> <area href="class_executioncontext.html" shape="rect" coords="7,219,116,198"> <area href="class_prefixresolver.html" shape="rect" coords="188,219,281,198"> <area href="class_xalandomstring.html" shape="rect" coords="484,38,593,16"> <area href="class_xpath.html" shape="rect" coords="567,219,612,198"> <area href="class_xpathexpression.html" shape="rect" coords="657,128,767,107"> <area href="class_locator.html" shape="rect" coords="791,128,841,107"> </map><p> <a href="class_nodesortkey-members.html">List of all members.</a><h2>Public Types</h2> <ul> <li>enum <a class="el" href="class_nodesortkey.html#s0">eCaseOrder</a> { <br> <a class="el" href="class_nodesortkey.html#a11">eDefault</a>, <br> <a class="el" href="class_nodesortkey.html#a12">eLowerFirst</a>, <br> <a class="el" href="class_nodesortkey.html#a13">eUpperFirst</a> <br> } </ul> <h2>Public Methods</h2> <ul> <li><a class="el" href="class_nodesortkey.html#a0">NodeSortKey</a> ( <a class="el" href="class_executioncontext.html">ExecutionContext</a>& executionContext, const <a class="el" href="class_xpath.html">XPath</a>& selectPat, bool treatAsNumbers, bool descending, <a class="el" href="class_nodesortkey.html#s0">eCaseOrder</a> caseOrder, const <a class="el" href="class_xalandomstring.html">XalanDOMString</a>& langValue, const <a class="el" href="class_prefixresolver.html">PrefixResolver</a>& resolver) <dl class="el"><dd><font size=-1><em>Construct a node sort key.</em> <a href="#a0">More...</a><em></em></font></dl><li><a class="el" href="class_nodesortkey.html#a1">NodeSortKey</a> () <li><a class="el" href="class_nodesortkey.html#a2">NodeSortKey</a> (const NodeSortKey& theSource) <li><a class="el" href="class_nodesortkey.html#a3">~NodeSortKey</a> () <li>NodeSortKey& <a class="el" href="class_nodesortkey.html#a4">operator=</a> (const NodeSortKey& theRHS) <li>const <a class="el" href="class_xpath.html">XPath</a>* <a class="el" href="class_nodesortkey.html#a5">getSelectPattern</a> () const <dl class="el"><dd><font size=-1><em>Retrieve the selection <a class="el" href="class_xpath.html">XPath</a>.</em> <a href="#a5">More...</a><em></em></font></dl><li>bool <a class="el" href="class_nodesortkey.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></em></font></dl><li>bool <a class="el" href="class_nodesortkey.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></em></font></dl><li><a class="el" href="class_nodesortkey.html#s0">eCaseOrder</a> <a class="el" href="class_nodesortkey.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></em></font></dl><li>const <a class="el" href="class_prefixresolver.html">PrefixResolver</a>* <a class="el" href="class_nodesortkey.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></em></font></dl><li>const <a class="el" href="class_xalandomstring.html">XalanDOMString</a>& <a class="el" href="class_nodesortkey.html#a10">getLanguageString</a> () const </ul> <hr><a name="_details"></a><h2>Detailed Description</h2> Simple data structure class for use by the <a class="el" href="class_nodesorter.html">NodeSorter</a> class. <p> <p> <hr><h2>Member Enumeration Documentation</h2> <a name="s0" doxytag="NodeSortKey::eCaseOrder"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> enum NodeSortKey::eCaseOrder</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> <dl compact><dt> <b>Enumeration values:</b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><a name="a11" doxytag="eDefault"><em>eDefault</em></a> </td><td> </td></tr> <tr><td valign=top><a name="a12" doxytag="eLowerFirst"><em>eLowerFirst</em></a> </td><td> </td></tr> <tr><td valign=top><a name="a13" doxytag="eUpperFirst"><em>eUpperFirst</em></a> </td><td> </td></tr> </table> </dl> </div> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="NodeSortKey::NodeSortKey"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> NodeSortKey::NodeSortKey ( </b></td> <td><b> <a class="el" href="class_executioncontext.html">ExecutionContext</a> & <em>executionContext</em>, </b></td></tr> <tr><td></td><td><b> const <a class="el" href="class_xpath.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="class_nodesortkey.html#s0">eCaseOrder</a> <em>caseOrder</em>, </b></td></tr> <tr><td></td><td><b> const <a class="el" href="class_xalandomstring.html">XalanDOMString</a> & <em>langValue</em>, </b></td></tr> <tr><td></td><td><b> const <a class="el" href="class_prefixresolver.html">PrefixResolver</a> & <em>resolver</em>)</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <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> </td><td> current execution context </td></tr> <tr><td valign=top><em>selectPat</em> </td><td> <a class="el" href="class_xpath.html">XPath</a> for selection </td></tr> <tr><td valign=top><em>treatAsNumbers</em> </td><td> treat as numeric values if true </td></tr> <tr><td valign=top><em>descending</em> </td><td> sort in descending order if true </td></tr> <tr><td valign=top><em>caseOrder</em> </td><td> case sort order enum </td></tr> <tr><td valign=top><em>langValue</em> </td><td> language </td></tr> <tr><td valign=top><em>resolver</em> </td><td> resolver for namespace resolution </td></tr> </table> </dl></div> <a name="a1" doxytag="NodeSortKey::NodeSortKey"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> NodeSortKey::NodeSortKey ()</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> </div> <a name="a2" doxytag="NodeSortKey::NodeSortKey"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> NodeSortKey::NodeSortKey ( </b></td> <td><b> const NodeSortKey & <em>theSource</em>)</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> </div> <a name="a3" doxytag="NodeSortKey::~NodeSortKey"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> NodeSortKey::~NodeSortKey ()</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> </div> <hr><h2>Member Function Documentation</h2> <a name="a8" doxytag="NodeSortKey::getCaseOrder"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> <a class="el" href="class_nodesortkey.html#s0">eCaseOrder</a> NodeSortKey::getCaseOrder () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <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></div> <a name="a7" doxytag="NodeSortKey::getDescending"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> bool NodeSortKey::getDescending () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> Whether to sort in descending order. <p> <dl compact><dt> <b>Returns: </b><dd> sort in descending order if true </dl></div> <a name="a10" doxytag="NodeSortKey::getLanguageString"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> const <a class="el" href="class_xalandomstring.html">XalanDOMString</a> & NodeSortKey::getLanguageString () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> </div> <a name="a9" doxytag="NodeSortKey::getPrefixResolver"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> const <a class="el" href="class_prefixresolver.html">PrefixResolver</a> * NodeSortKey::getPrefixResolver () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> Retrieve the resolver for namespaces. <p> <dl compact><dt> <b>Returns: </b><dd> object for namespace resolution </dl></div> <a name="a5" doxytag="NodeSortKey::getSelectPattern"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> const <a class="el" href="class_xpath.html">XPath</a> * NodeSortKey::getSelectPattern () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> Retrieve the selection <a class="el" href="class_xpath.html">XPath</a>. <p> <dl compact><dt> <b>Returns: </b><dd> <a class="el" href="class_xpath.html">XPath</a> for selection </dl></div> <a name="a6" doxytag="NodeSortKey::getTreatAsNumbers"><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> bool NodeSortKey::getTreatAsNumbers () const</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> Whether to treat values as numbers. <p> <dl compact><dt> <b>Returns: </b><dd> treat as numeric values if true </dl></div> <a name="a4" doxytag="NodeSortKey::operator="><p> <table width=100% cellpadding=2 cellspacing=0 border=0> <tr> <td class="md"><b> <table cellspadding=0 cellspacing=0 border=0> <tr> <td><b> NodeSortKey& NodeSortKey::operator= ( </b></td> <td><b> const NodeSortKey & <em>theRHS</em>)</b></td></tr> </b></td> </tr> </table> </td> </tr> </table> </a> <div class="in"> <p> </div> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="NodeSortKey.hpp.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="images/dot.gif" width="1"></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.4</B><BR> Copyright © 2000, 2001, 2002 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"> </TD> </TR> </TABLE>