Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorpelder2008-04-21 22:12:56 -0400
committerpelder2008-04-21 22:12:56 -0400
commit154bd694cd2c0fe061bb7d17c6ac7e442ec1036f (patch)
tree95cedaf9ff9ceae4a184b9e879ef387f673baddb /doc
parente770f7b671da5d4a5f70cd42772a6cc3e29cad28 (diff)
downloadorg.eclipse.jet-154bd694cd2c0fe061bb7d17c6ac7e442ec1036f.tar.gz
org.eclipse.jet-154bd694cd2c0fe061bb7d17c6ac7e442ec1036f.tar.xz
org.eclipse.jet-154bd694cd2c0fe061bb7d17c6ac7e442ec1036f.zip
[224337] I'd need to SORT the results of a jet xpath select
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.jet.doc/references/xpathFunctions/overview.html8
-rwxr-xr-xdoc/org.eclipse.jet.doc/references/xpathFunctions/sortFunction.html93
-rw-r--r--doc/org.eclipse.jet.doc/toc.xml5
3 files changed, 105 insertions, 1 deletions
diff --git a/doc/org.eclipse.jet.doc/references/xpathFunctions/overview.html b/doc/org.eclipse.jet.doc/references/xpathFunctions/overview.html
index d43c31e..e3bbf5f 100644
--- a/doc/org.eclipse.jet.doc/references/xpathFunctions/overview.html
+++ b/doc/org.eclipse.jet.doc/references/xpathFunctions/overview.html
@@ -96,6 +96,14 @@ The following functions are included in JET, in addition to the XPath functions
</TD>
</TR>
<TR>
+ <TD width="10%"><A href="sortFunction.html">sort</A></TD>
+ <TD>
+ <!-- Begin sort description -->
+ Sort a node set by the specified sort keys.
+ <!-- End sort description -->
+ </TD>
+ </TR>
+ <TR>
<TD width="10%"><A href="trimWhitespaceFunction.html">trimWhitespace</A></TD>
<TD>
<!-- Begin trimWhitespace description -->
diff --git a/doc/org.eclipse.jet.doc/references/xpathFunctions/sortFunction.html b/doc/org.eclipse.jet.doc/references/xpathFunctions/sortFunction.html
new file mode 100755
index 0000000..e86db70
--- /dev/null
+++ b/doc/org.eclipse.jet.doc/references/xpathFunctions/sortFunction.html
@@ -0,0 +1,93 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML>
+<HEAD>
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<META name="GENERATOR" content="IBM Software Development Platform">
+<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css"/>
+<TITLE>removeWhitespace XPath function</TITLE>
+</HEAD>
+<BODY>
+<TABLE border="0" cellpadding="0" cellspacing="1" width="100%">
+ <TBODY>
+ <TR>
+ <TH align="left"><P>sort()</P></TH>
+ <TH align="right"><A href="overview.html">Additional XPath Functions</A></TH>
+ </TR>
+ </TBODY>
+</TABLE>
+<HR>
+<H2>sort</H2>
+<P>Sort a node set by the specified sort keys.</P>
+<HR>
+<TABLE border="0" width="100%">
+ <TBODY>
+ <TR>
+ <TH colspan="2" align="left">Function Summary<BR>&nbsp;</TH></TR>
+ <TR>
+ <TD width="20%" valign="top">minimal arguments</TD>
+ <TD><SPAN style="font-family: monospace" valign="top">
+ NodeSet sort (XPath expression, String sortKey)<BR>&nbsp;<BR>
+ </SPAN></TD>
+ </TR>
+ <TR>
+ <TD width="20%" valign="top">all arguments</TD>
+ <TD><SPAN style="font-family: monospace" valign="top">
+ NodeSet sort (XPath expression, String sortKey, String sortKey2, ...)<BR>&nbsp;<BR>
+ </SPAN></TD>
+ </TR>
+ </TBODY>
+</TABLE>
+<HR>
+<TABLE border="0" width="100%">
+ <TBODY>
+ <TR>
+ <TH colspan="2" align="left">Required Arguments<BR>&nbsp;</TH>
+ </TR>
+ <TR>
+ <TD width="20%" valign="top"><B>XPath expression</B></TD>
+ <TD>an XPath expression identifying the nodes to sort</TD>
+ </TR>
+ <TR>
+ <TD width="20%" valign="top"><B>String sortKey</B></TD>
+ <TD>a quoted String containing an XPath expression for a sort key.
+ The XPath expression is evaluated relative to each node in the node set being sorted.
+ Optionally, the string my be suffixed with ::ascending or ::descending to
+ indicate sort direction. The default sort direction is ascending.</TD>
+ </TR>
+ </TBODY>
+</TABLE>
+<HR>
+<TABLE border="0" width="100%">
+ <TBODY>
+ <TR>
+ <TH colspan="2" align="left">Optional arguments<BR>&nbsp;</TH>
+ </TR>
+ <TR>
+ <TD width="20%" valign="top"><B>String sortKey<i>N</i></B></TD>
+ <TD>a secondary sort key should previous keys have resulted in equality.
+ Format rules are as with sorkKey.</TD>
+ </TR>
+ </TBODY>
+</TABLE>
+<HR>
+<TABLE border="0" width="100%">
+ <TBODY>
+ <TR>
+ <TH colspan="2" align="left">Example<BR>&nbsp;</TH></TR>
+ <TR>
+ <TD colspan="2"><SPAN style="font-family: monospace">
+<!-- Begin sort example -->
+ <B>sort</B>(/phonebook/entry, '@lastName')<br>
+ <P>returns a node set of phone book entries sorted by lastName</P>
+ <B>sort</B>(/phonebook/entry, 'substring(@lastName, 1, 1)::descending', @firstName::ascending)<br>
+ <P>returns a node set of phone book entries sorted in reverse order by the first letter of lastName
+ and, within each letter, alphabetically by firstName</P>
+<!-- End sort example -->
+</SPAN></TD>
+ </TR>
+ </TBODY>
+</TABLE>
+<P><BR>
+<FONT color="navy" size="-2">&copy; Copyright IBM Corporation 2000,
+2008. All Rights Reserved.</FONT></P></P></BODY>
+</HTML>
diff --git a/doc/org.eclipse.jet.doc/toc.xml b/doc/org.eclipse.jet.doc/toc.xml
index 6c2a5a7..013d07c 100644
--- a/doc/org.eclipse.jet.doc/toc.xml
+++ b/doc/org.eclipse.jet.doc/toc.xml
@@ -50,7 +50,10 @@
<topic label="lower-case" href="references/xpathFunctions/lower_caseFunction.html"/>
<topic label="lowercaseFirst" href="references/xpathFunctions/lowercaseFirstFunction.html"/>
<topic label="packageName" href="references/xpathFunctions/packageNameFunction.html"/>
- <topic label="removeWhitespace" href="references/xpathFunctions/removeWhitespaceFunction.html"/>
+ <topic href="references/xpathFunctions/removeWhitespaceFunction.html" label="removeWhitespace">
+ </topic>
+ <topic href="references/xpathFunctions/sortFunction.html" label="sort">
+ </topic>
<topic label="trimWhitespace" href="references/xpathFunctions/trimWhitespaceFunction.html"/>
<topic label="upper-case" href="references/xpathFunctions/upper_caseFunction.html"/>
<topic label="uppercaseFirst" href="references/xpathFunctions/uppercaseFirstFunction.html"/>

Back to the top