| java.lang.Object net.sf.saxon.sort.SortKeyDefinition
All known Subclasses: net.sf.saxon.sort.FixedSortKeyDefinition,
SortKeyDefinition | public class SortKeyDefinition implements Serializable(Code) | | A SortKeyDefinition defines one component of a sort key.
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.
|
emptyFirst | protected boolean emptyFirst(Code) | | |
getEmptyFirst | public boolean getEmptyFirst()(Code) | | |
getSortKey | public Expression getSortKey()(Code) | | Get the expression used as the sort key
|
reduce | public FixedSortKeyDefinition reduce(XPathContext context) throws XPathException(Code) | | Evaluate any aspects of the sort definition that were specified as AVTs, for example
ascending/descending, language, case-order, data-type. This is done at the start of each
sort. A FixedSortKeyDefinition is a SortKeyDefinition in which these properties are all
known values.
|
setCaseOrder | public void setCaseOrder(Expression exp)(Code) | | 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".
|
setCollationName | public void setCollationName(Expression collationName)(Code) | | Set the collation.
|
setDataTypeExpression | public void setDataTypeExpression(Expression exp)(Code) | | 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.
|
setEmptyFirst | public void setEmptyFirst(boolean emptyFirst)(Code) | | Set whether empty sequence comes before other values or after them
Parameters: emptyFirst - true if () is considered lower than any other value |
setLanguage | public void setLanguage(Expression exp)(Code) | | 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").
|
setOrder | public void setOrder(Expression exp)(Code) | | 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".
|
setParentExpression | public void setParentExpression(Container container)(Code) | | |
setSortKey | public void setSortKey(Expression exp)(Code) | | Set the expression used as the sort key
|
|
|