<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:15 GMT 2011 -->
<TITLE>
SortKeyDefinition
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SortKeyDefinition";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../net/sf/saxon/expr/sort/SortExpression.html" title="class in net.sf.saxon.expr.sort"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyEvaluator.html" title="interface in net.sf.saxon.expr.sort"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/sort/SortKeyDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="SortKeyDefinition.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.expr.sort</FONT>
<BR>
Class SortKeyDefinition</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.expr.sort.SortKeyDefinition</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>SortKeyDefinition</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
</PRE>
<P>
A SortKeyDefinition defines one component of a sort key. <BR>
Note that most attributes defining the sort key can be attribute value templates,
and can therefore vary from one invocation to another. We hold them as expressions. As
soon as they are all known (which in general is only at run-time), the SortKeyDefinition
is replaced by a FixedSortKeyDefinition in which all these values are fixed.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#net.sf.saxon.expr.sort.SortKeyDefinition">Serialized Form</A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#backwardsCompatible">backwardsCompatible</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#baseURI">baseURI</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#caseOrder">caseOrder</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#collation">collation</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#collationName">collationName</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#dataTypeExpression">dataTypeExpression</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#emptyLeast">emptyLeast</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#language">language</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#order">order</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setContextForSortKey">setContextForSortKey</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#sortKey">sortKey</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#stable">stable</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#SortKeyDefinition()">SortKeyDefinition</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#copy()">copy</A></B>()</CODE>
<BR>
Copy this SortKeyDefinition</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE>
<BR>
Compare two SortKeyDefinition values for equality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#fix(net.sf.saxon.expr.XPathContext)">fix</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getBaseURI()">getBaseURI</A></B>()</CODE>
<BR>
Get the static base URI of the expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getCaseOrder()">getCaseOrder</A></B>()</CODE>
<BR>
Get the expression that defines the case order of the sort keys.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getCollation()">getCollation</A></B>()</CODE>
<BR>
Get the collation to be used</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getCollationNameExpression()">getCollationNameExpression</A></B>()</CODE>
<BR>
Get the selected collation name
(specifically, an expression which when evaluated returns the collation URI).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getDataTypeExpression()">getDataTypeExpression</A></B>()</CODE>
<BR>
Get the expression that defines the data type of the sort keys</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getEmptyLeast()">getEmptyLeast</A></B>()</CODE>
<BR>
Ask whether empty sequence comes before other values or after them</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getFinalComparator()">getFinalComparator</A></B>()</CODE>
<BR>
Get the comparator which is used to compare two values according to this sort key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getLanguage()">getLanguage</A></B>()</CODE>
<BR>
Get the expression that defines the language of the sort keys</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getOrder()">getOrder</A></B>()</CODE>
<BR>
Get the expression that defines the order as ascending or descending</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getSortKey()">getSortKey</A></B>()</CODE>
<BR>
Get the expression used as the sort key</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#getStable()">getStable</A></B>()</CODE>
<BR>
Ask whether this sort key definition is stable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
Get a hashcode to reflect the equals() method</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#isBackwardsCompatible()">isBackwardsCompatible</A></B>()</CODE>
<BR>
Ask whether this sort key is evaluated in XSLT 1.0 backwards compatibility mode</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#isFixed()">isFixed</A></B>()</CODE>
<BR>
Ask whether the sort key definition is fixed, that is, whether all the information needed
to create a Comparator is known statically</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#isSetContextForSortKey()">isSetContextForSortKey</A></B>()</CODE>
<BR>
Ask whether the sortkey is to be evaluated with the item-being-sorted
as the context item</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#makeComparator(net.sf.saxon.expr.XPathContext)">makeComparator</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Allocate an AtomicComparer to perform the comparisons described by this sort key component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#processSubExpressions(net.sf.saxon.expr.flwor.ExpressionProcessor)">processSubExpressions</A></B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/ExpressionProcessor.html" title="interface in net.sf.saxon.expr.flwor">ExpressionProcessor</A> processor)</CODE>
<BR>
Process the subexpressions of this clause</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setBackwardsCompatible(boolean)">setBackwardsCompatible</A></B>(boolean compatible)</CODE>
<BR>
Set whether this sort key is evaluated in XSLT 1.0 backwards compatibility mode</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setBaseURI(java.lang.String)">setBaseURI</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> baseURI)</CODE>
<BR>
Set the base URI of the expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setCaseOrder(net.sf.saxon.expr.Expression)">setCaseOrder</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</CODE>
<BR>
Set the case order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setCollation(net.sf.saxon.lib.StringCollator)">setCollation</A></B>(<A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> collation)</CODE>
<BR>
Set the collation to be used</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setCollationNameExpression(net.sf.saxon.expr.Expression)">setCollationNameExpression</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> collationName)</CODE>
<BR>
Set the collation name (specifically, an expression which when evaluated returns the collation URI).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setDataTypeExpression(net.sf.saxon.expr.Expression)">setDataTypeExpression</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</CODE>
<BR>
Set the data type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setEmptyLeast(boolean)">setEmptyLeast</A></B>(boolean emptyLeast)</CODE>
<BR>
Set whether empty sequence comes before other values or after them</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setFinalComparator(net.sf.saxon.expr.sort.AtomicComparer)">setFinalComparator</A></B>(<A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A> comp)</CODE>
<BR>
Set the comparator which is used to compare two values according to this sort key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setLanguage(net.sf.saxon.expr.Expression)">setLanguage</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</CODE>
<BR>
Set the language.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setOrder(net.sf.saxon.expr.Expression)">setOrder</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</CODE>
<BR>
Set the order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setSortKey(net.sf.saxon.expr.Expression, boolean)">setSortKey</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp,
boolean setContext)</CODE>
<BR>
Set the expression used as the sort key</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#setStable(net.sf.saxon.expr.Expression)">setStable</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> stable)</CODE>
<BR>
Set whether this sort key definition is stable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#simplify(net.sf.saxon.expr.parser.ExpressionVisitor)">simplify</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor)</CODE>
<BR>
Simplify this sort key definition</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">typeCheck</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor,
<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.ContextItemType.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor.ContextItemType</A> contextItemType)</CODE>
<BR>
Type-check this sort key definition (all properties other than the sort key
select expression, when it has a different dynamic context)</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="sortKey"><!-- --></A><H3>
sortKey</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>sortKey</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="order"><!-- --></A><H3>
order</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>order</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="dataTypeExpression"><!-- --></A><H3>
dataTypeExpression</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>dataTypeExpression</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="caseOrder"><!-- --></A><H3>
caseOrder</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>caseOrder</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="language"><!-- --></A><H3>
language</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>language</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="collationName"><!-- --></A><H3>
collationName</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>collationName</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="stable"><!-- --></A><H3>
stable</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>stable</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="collation"><!-- --></A><H3>
collation</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> <B>collation</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="baseURI"><!-- --></A><H3>
baseURI</H3>
<PRE>
protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>baseURI</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="emptyLeast"><!-- --></A><H3>
emptyLeast</H3>
<PRE>
protected boolean <B>emptyLeast</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="backwardsCompatible"><!-- --></A><H3>
backwardsCompatible</H3>
<PRE>
protected boolean <B>backwardsCompatible</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="setContextForSortKey"><!-- --></A><H3>
setContextForSortKey</H3>
<PRE>
protected boolean <B>setContextForSortKey</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SortKeyDefinition()"><!-- --></A><H3>
SortKeyDefinition</H3>
<PRE>
public <B>SortKeyDefinition</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setSortKey(net.sf.saxon.expr.Expression, boolean)"><!-- --></A><H3>
setSortKey</H3>
<PRE>
public void <B>setSortKey</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp,
boolean setContext)</PRE>
<DL>
<DD>Set the expression used as the sort key
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the sort key select expression<DD><CODE>setContext</CODE> - set to true if the sort key is to be evaluated with the
item-being-sorted as the context item (as in XSLT); false if the context item
is not to be set (as in XQuery)</DL>
</DD>
</DL>
<HR>
<A NAME="getSortKey()"><!-- --></A><H3>
getSortKey</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getSortKey</B>()</PRE>
<DL>
<DD>Get the expression used as the sort key
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the sort key select expression</DL>
</DD>
</DL>
<HR>
<A NAME="isSetContextForSortKey()"><!-- --></A><H3>
isSetContextForSortKey</H3>
<PRE>
public boolean <B>isSetContextForSortKey</B>()</PRE>
<DL>
<DD>Ask whether the sortkey is to be evaluated with the item-being-sorted
as the context item
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the context needs to be set for evaluating the sort key</DL>
</DD>
</DL>
<HR>
<A NAME="setOrder(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setOrder</H3>
<PRE>
public void <B>setOrder</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</PRE>
<DL>
<DD>Set the order. This is supplied as an expression which must evaluate to "ascending"
or "descending". If the order is fixed, supply e.g. new StringValue("ascending").
Default is "ascending".
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the expression that determines the order (always a literal in XQuery, but
can be defined by an AVT in XSLT)</DL>
</DD>
</DL>
<HR>
<A NAME="getOrder()"><!-- --></A><H3>
getOrder</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getOrder</B>()</PRE>
<DL>
<DD>Get the expression that defines the order as ascending or descending
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression that determines the order (always a literal in XQuery, but
can be defined by an AVT in XSLT)</DL>
</DD>
</DL>
<HR>
<A NAME="setDataTypeExpression(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setDataTypeExpression</H3>
<PRE>
public void <B>setDataTypeExpression</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</PRE>
<DL>
<DD>Set the data type. This is supplied as an expression which must evaluate to "text",
"number", or a QName. If the data type is fixed, the valus should be supplied using
setDataType() and not via this method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the expression that defines the data type, as used in XSLT 1.0</DL>
</DD>
</DL>
<HR>
<A NAME="getDataTypeExpression()"><!-- --></A><H3>
getDataTypeExpression</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getDataTypeExpression</B>()</PRE>
<DL>
<DD>Get the expression that defines the data type of the sort keys
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression that defines the data type, as used in XSLT 1.0</DL>
</DD>
</DL>
<HR>
<A NAME="setCaseOrder(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setCaseOrder</H3>
<PRE>
public void <B>setCaseOrder</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</PRE>
<DL>
<DD>Set the case order. This is supplied as an expression which must evaluate to "upper-first"
or "lower-first" or "#default". If the order is fixed, supply e.g. new StringValue("lower-first").
Default is "#default".
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the expression that defines the case order</DL>
</DD>
</DL>
<HR>
<A NAME="getCaseOrder()"><!-- --></A><H3>
getCaseOrder</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getCaseOrder</B>()</PRE>
<DL>
<DD>Get the expression that defines the case order of the sort keys.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression that defines the case order, whose run-time value will be "upper-first",
"lower-first", or "#default".</DL>
</DD>
</DL>
<HR>
<A NAME="setLanguage(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setLanguage</H3>
<PRE>
public void <B>setLanguage</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp)</PRE>
<DL>
<DD>Set the language. This is supplied as an expression which evaluates to the language name.
If the order is fixed, supply e.g. new StringValue("de").
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the expression that determines the language</DL>
</DD>
</DL>
<HR>
<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getLanguage</B>()</PRE>
<DL>
<DD>Get the expression that defines the language of the sort keys
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>exp the expression that determines the language</DL>
</DD>
</DL>
<HR>
<A NAME="setCollationNameExpression(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setCollationNameExpression</H3>
<PRE>
public void <B>setCollationNameExpression</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> collationName)</PRE>
<DL>
<DD>Set the collation name (specifically, an expression which when evaluated returns the collation URI).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>collationName</CODE> - the expression that determines the collation name</DL>
</DD>
</DL>
<HR>
<A NAME="getCollationNameExpression()"><!-- --></A><H3>
getCollationNameExpression</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getCollationNameExpression</B>()</PRE>
<DL>
<DD>Get the selected collation name
(specifically, an expression which when evaluated returns the collation URI).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression that determines the collation name</DL>
</DD>
</DL>
<HR>
<A NAME="setCollation(net.sf.saxon.lib.StringCollator)"><!-- --></A><H3>
setCollation</H3>
<PRE>
public void <B>setCollation</B>(<A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> collation)</PRE>
<DL>
<DD>Set the collation to be used
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>collation</CODE> - A StringCollator, which encapsulates both the collation URI and the collating function</DL>
</DD>
</DL>
<HR>
<A NAME="getCollation()"><!-- --></A><H3>
getCollation</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A> <B>getCollation</B>()</PRE>
<DL>
<DD>Get the collation to be used
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A StringCollator, which encapsulates both the collation URI and the collating function</DL>
</DD>
</DL>
<HR>
<A NAME="setBaseURI(java.lang.String)"><!-- --></A><H3>
setBaseURI</H3>
<PRE>
public void <B>setBaseURI</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> baseURI)</PRE>
<DL>
<DD>Set the base URI of the expression. This is needed to handle the case where a collation URI
evaluated at run-time turns out to be a relative URI.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseURI</CODE> - the static base URI of the expression</DL>
</DD>
</DL>
<HR>
<A NAME="getBaseURI()"><!-- --></A><H3>
getBaseURI</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getBaseURI</B>()</PRE>
<DL>
<DD>Get the static base URI of the expression. This is needed to handle the case where a collation URI
evaluated at run-time turns out to be a relative URI.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the static base URI of the expression</DL>
</DD>
</DL>
<HR>
<A NAME="setStable(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setStable</H3>
<PRE>
public void <B>setStable</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> stable)</PRE>
<DL>
<DD>Set whether this sort key definition is stable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stable</CODE> - the expression that determines whether the sort key definition is stable
(it evaluates to the string "yes" or "no".</DL>
</DD>
</DL>
<HR>
<A NAME="getStable()"><!-- --></A><H3>
getStable</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getStable</B>()</PRE>
<DL>
<DD>Ask whether this sort key definition is stable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression that determines whether the sort key definition is stable
(it evaluates to the string "yes" or "no".</DL>
</DD>
</DL>
<HR>
<A NAME="setBackwardsCompatible(boolean)"><!-- --></A><H3>
setBackwardsCompatible</H3>
<PRE>
public void <B>setBackwardsCompatible</B>(boolean compatible)</PRE>
<DL>
<DD>Set whether this sort key is evaluated in XSLT 1.0 backwards compatibility mode
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compatible</CODE> - true if backwards compatibility mode is selected</DL>
</DD>
</DL>
<HR>
<A NAME="isBackwardsCompatible()"><!-- --></A><H3>
isBackwardsCompatible</H3>
<PRE>
public boolean <B>isBackwardsCompatible</B>()</PRE>
<DL>
<DD>Ask whether this sort key is evaluated in XSLT 1.0 backwards compatibility mode
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if backwards compatibility mode was selected</DL>
</DD>
</DL>
<HR>
<A NAME="setEmptyLeast(boolean)"><!-- --></A><H3>
setEmptyLeast</H3>
<PRE>
public void <B>setEmptyLeast</B>(boolean emptyLeast)</PRE>
<DL>
<DD>Set whether empty sequence comes before other values or after them
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>emptyLeast</CODE> - true if () is considered lower than any other value</DL>
</DD>
</DL>
<HR>
<A NAME="getEmptyLeast()"><!-- --></A><H3>
getEmptyLeast</H3>
<PRE>
public boolean <B>getEmptyLeast</B>()</PRE>
<DL>
<DD>Ask whether empty sequence comes before other values or after them
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if () is considered lower than any other value</DL>
</DD>
</DL>
<HR>
<A NAME="isFixed()"><!-- --></A><H3>
isFixed</H3>
<PRE>
public boolean <B>isFixed</B>()</PRE>
<DL>
<DD>Ask whether the sort key definition is fixed, that is, whether all the information needed
to create a Comparator is known statically
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if all information needed to create a Comparator is known statically</DL>
</DD>
</DL>
<HR>
<A NAME="simplify(net.sf.saxon.expr.parser.ExpressionVisitor)"><!-- --></A><H3>
simplify</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A> <B>simplify</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Simplify this sort key definition
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the expression visitor
<DT><B>Returns:</B><DD>the simplified sort key definition
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any failure occurs</DL>
</DD>
</DL>
<HR>
<A NAME="copy()"><!-- --></A><H3>
copy</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A> <B>copy</B>()</PRE>
<DL>
<DD>Copy this SortKeyDefinition
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)"><!-- --></A><H3>
typeCheck</H3>
<PRE>
public void <B>typeCheck</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor,
<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.ContextItemType.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor.ContextItemType</A> contextItemType)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Type-check this sort key definition (all properties other than the sort key
select expression, when it has a different dynamic context)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the expression visitor<DD><CODE>contextItemType</CODE> - the type of the context item
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any failure occurs</DL>
</DD>
</DL>
<HR>
<A NAME="processSubExpressions(net.sf.saxon.expr.flwor.ExpressionProcessor)"><!-- --></A><H3>
processSubExpressions</H3>
<PRE>
public void <B>processSubExpressions</B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/ExpressionProcessor.html" title="interface in net.sf.saxon.expr.flwor">ExpressionProcessor</A> processor)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Process the subexpressions of this clause
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>processor</CODE> - the expression processor used to process the subexpressions
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="makeComparator(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
makeComparator</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A> <B>makeComparator</B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Allocate an AtomicComparer to perform the comparisons described by this sort key component. This method
is called at run-time. The AtomicComparer takes into account not only the collation, but also parameters
such as order=descending and handling of empty sequence and NaN (the result of the compare()
method of the comparator is +1 if the second item is to sort after the first item)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the dynamic evaluation context
<DT><B>Returns:</B><DD>an AtomicComparer suitable for making the sort comparisons
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setFinalComparator(net.sf.saxon.expr.sort.AtomicComparer)"><!-- --></A><H3>
setFinalComparator</H3>
<PRE>
public void <B>setFinalComparator</B>(<A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A> comp)</PRE>
<DL>
<DD>Set the comparator which is used to compare two values according to this sort key. The comparator makes the final
decision whether one value sorts before or after another: this takes into account the data type, the collation,
whether empty comes first or last, whether the sort order is ascending or descending.
<p>This method is called at compile time if all these factors are known at compile time.
It must not be called at run-time, except to reconstitute a finalComparator that has been
lost by virtue of serialization .</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comp</CODE> - the Atomic Comparer to be used</DL>
</DD>
</DL>
<HR>
<A NAME="getFinalComparator()"><!-- --></A><H3>
getFinalComparator</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/sort/AtomicComparer.html" title="interface in net.sf.saxon.expr.sort">AtomicComparer</A> <B>getFinalComparator</B>()</PRE>
<DL>
<DD>Get the comparator which is used to compare two values according to this sort key. This method
may be called either at compile time or at run-time. If no comparator has been allocated,
it returns null. It is then necessary to allocate a comparator using the <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html#makeComparator(net.sf.saxon.expr.XPathContext)"><CODE>makeComparator(net.sf.saxon.expr.XPathContext)</CODE></A>
method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the Atomic Comparer to be used</DL>
</DD>
</DL>
<HR>
<A NAME="fix(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
fix</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyDefinition.html" title="class in net.sf.saxon.expr.sort">SortKeyDefinition</A> <B>fix</B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE>
<DL>
<DD>Compare two SortKeyDefinition values for equality. This compares the sortKeys and attribute values.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - SortKeyDefinition
<DT><B>Returns:</B><DD>boolean</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD>Get a hashcode to reflect the equals() method
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a hashcode based sortkey attribute values.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../net/sf/saxon/expr/sort/SortExpression.html" title="class in net.sf.saxon.expr.sort"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/sort/SortKeyEvaluator.html" title="interface in net.sf.saxon.expr.sort"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/sort/SortKeyDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="SortKeyDefinition.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
