Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.icl.saxon.expr

Class SortKeyEnumeration

Implemented Interfaces:
LastPositionFinder, NodeEnumeration, Sortable
public final class SortKeyEnumeration
extends java.lang.Object
implements NodeEnumeration, LastPositionFinder, Sortable
A SortKeyEnumeration is NodeEnumeration that delivers the nodes sorted according to a specified sort key.

Nested Class Summary

Field Summary

protected NodeEnumeration
base

Constructor Summary

SortKeyEnumeration(Context context, NodeEnumeration _base, SortKeyDefinition sortkeys)

Method Summary

int
compare(int a, int b)
Compare two nodes in sorted sequence (needed to implement the Sortable interface)
int
getLastPosition()
Get the last position
boolean
hasMoreElements()
Determine whether there are more nodes
boolean
isPeer()
Determine whether the nodes returned by this enumeration are known to be peers, that is, no node is a descendant or ancestor of another node.
boolean
isReverseSorted()
Determine whether the nodes returned by this enumeration are known to be in reverse document order.
boolean
isSorted()
Determine whether the nodes returned by this enumeration are known to be in document order
NodeInfo
nextElement()
Get the next node, in sorted order
void
swap(int a, int b)
Swap two nodes (needed to implement the Sortable interface)

Field Details

base

protected NodeEnumeration base

Constructor Details

SortKeyEnumeration

public SortKeyEnumeration(Context context,
                          NodeEnumeration _base,
                          SortKeyDefinition sortkeys)
            throws XPathException

Method Details

compare

public int compare(int a,
                   int b)
Compare two nodes in sorted sequence (needed to implement the Sortable interface)
Specified by:
compare in interface Sortable

getLastPosition

public int getLastPosition()
            throws XPathException
Get the last position
Specified by:
getLastPosition in interface LastPositionFinder

hasMoreElements

public boolean hasMoreElements()
Determine whether there are more nodes
Specified by:
hasMoreElements in interface NodeEnumeration

isPeer

public boolean isPeer()
Determine whether the nodes returned by this enumeration are known to be peers, that is, no node is a descendant or ancestor of another node. This significance of this property is that if a peer enumeration is applied to each node in a set derived from another peer enumeration, and if both enumerations are sorted, then the result is also sorted.
Specified by:
isPeer in interface NodeEnumeration

isReverseSorted

public boolean isReverseSorted()
Determine whether the nodes returned by this enumeration are known to be in reverse document order.
Specified by:
isReverseSorted in interface NodeEnumeration

Returns:
true if the nodes are guaranteed to be in document order.

isSorted

public boolean isSorted()
Determine whether the nodes returned by this enumeration are known to be in document order
Specified by:
isSorted in interface NodeEnumeration

Returns:
true if the nodes are guaranteed to be in document order.

nextElement

public NodeInfo nextElement()
            throws XPathException
Get the next node, in sorted order
Specified by:
nextElement in interface NodeEnumeration

swap

public void swap(int a,
                 int b)
Swap two nodes (needed to implement the Sortable interface)
Specified by:
swap in interface Sortable

Overview Package Tree Index Deprecated About