Package com.icl.saxon.expr
Class SortedSelection
java.lang.Object
com.icl.saxon.expr.Expression
com.icl.saxon.expr.NodeSetExpression
com.icl.saxon.expr.SortedSelection
A NodeSetExpression that retrieves nodes in order according to a specified sort key.
Note there is no direct XSL expression syntax that generates this.
The expression sorts a base NodeSet according to the value of a specified sort key. The sort key may be composite. The base NodeSet will always be in document order.
Note there is no direct XSL expression syntax that generates this.
The expression sorts a base NodeSet according to the value of a specified sort key. The sort key may be composite. The base NodeSet will always be in document order.
-
Field Summary
Fields inherited from class com.icl.saxon.expr.Expression
staticContext
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
display
(int level) Diagnostic print of expression structureEvaluate the expression by sorting the base nodeset using the supplied key.int
Determine which aspects of the context the expression depends on.Perform a partial evaluation of the expression, by eliminating specified dependencies on the context.void
setSortKey
(SortKeyDefinition sk, int k) Add a sort key and other sorting parameterssimplify()
Simplify an expressionMethods inherited from class com.icl.saxon.expr.NodeSetExpression
evaluate, evaluateAsBoolean, evaluateAsNodeSet, evaluateAsString, getDataType, outputStringValue, selectFirst
Methods inherited from class com.icl.saxon.expr.Expression
containsReferences, evaluateAsNumber, getStaticContext, indent, isContextDocumentNodeSet, make, setStaticContext, usesCurrent
-
Constructor Details
-
SortedSelection
Constructor- Parameters:
s
- An expression whose value is the base nodeset to be sortedk
- the number of sort keys
-
-
Method Details
-
setSortKey
Add a sort key and other sorting parameters- Parameters:
sk
- A SortKeyDefinitionk
- The index of this SortKeyDefinition. The first sort key in major-to-minor order is numbered 0 (zero), the others are 1, 2, ... in sequence.- Throws:
ArrayIndexOutOfBoundsException
- if the sort key index is out of range, according to the number of sort keys defined when the SortedSelection was initialized.
-
simplify
Simplify an expression- Overrides:
simplify
in classExpression
- Returns:
- the simplified expression
- Throws:
XPathException
-
getDependencies
public int getDependencies()Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as Context.VARIABLES and Context.CURRENT_NODE- Specified by:
getDependencies
in classExpression
-
reduce
Perform a partial evaluation of the expression, by eliminating specified dependencies on the context.- Specified by:
reduce
in classExpression
- Parameters:
dependencies
- The dependencies to be removedcontext
- The context to be used for the partial evaluation- Returns:
- a new expression that does not have any of the specified dependencies
- Throws:
XPathException
-
enumerate
Evaluate the expression by sorting the base nodeset using the supplied key.- Specified by:
enumerate
in classNodeSetExpression
- Parameters:
context
- The context for the evaluationsort
- : must be false (because document order would be meaningless)- Returns:
- the sorted nodeset
- Throws:
XPathException
- when the expression does not return a nodeset.
-
display
public void display(int level) Diagnostic print of expression structure- Specified by:
display
in classExpression
-