org.exist.dom
Class SortedNodeSet

java.lang.Object
  extended byorg.exist.xquery.value.AbstractSequence
      extended byorg.exist.dom.AbstractNodeSet
          extended byorg.exist.dom.SortedNodeSet
All Implemented Interfaces:
org.w3c.dom.NodeList, NodeSet, Sequence

public class SortedNodeSet
extends AbstractNodeSet


Field Summary
 
Fields inherited from interface org.exist.dom.NodeSet
ANCESTOR, DESCENDANT, EMPTY_SET, FOLLOWING, PRECEDING
 
Fields inherited from interface org.exist.xquery.value.Sequence
EMPTY_SEQUENCE
 
Constructor Summary
SortedNodeSet(BrokerPool pool, User user, java.lang.String sortExpr, AccessContext accessCtx)
           
 
Method Summary
 void add(NodeProxy proxy)
          Add a new proxy object to the node set.
 void addAll(org.w3c.dom.NodeList other)
           
 void addAll(NodeSet other)
          Add all nodes from the given node set.
 void addAll(Sequence other)
          Add all items from the given sequence to the node set.
 boolean contains(NodeProxy proxy)
          Check if this node set contains a node matching the document and node-id of the given NodeProxy object.
 NodeProxy get(DocumentImpl doc, NodeId nodeId)
           
 NodeProxy get(int pos)
          Get the node at position pos within this node set.
 NodeProxy get(NodeProxy proxy)
          Get a node from this node set matching the document and node id of the given NodeProxy.
 int getLength()
          Return the number of nodes contained in this node set.
 boolean hasOne()
          Returns whether the sequence has just one item or not.
 boolean isEmpty()
          Returns whether the sequence is empty or not.
 org.w3c.dom.Node item(int pos)
           
 Item itemAt(int pos)
          Returns the item located at the specified position within this sequence.
 SequenceIterator iterate()
          Returns an iterator over all items in the sequence.
 NodeSetIterator iterator()
          Return an iterator on the nodes in this list.
 SequenceIterator unorderedIterator()
          Returns an iterator over all items in the sequence.
 
Methods inherited from class org.exist.dom.AbstractNodeSet
add, add, clearContext, containsDoc, deepIntersection, directSelectAttribute, except, getAncestors, getContextNodes, getDocumentSet, getIndexType, getItemType, getParents, getProcessInReverseOrder, getSizeHint, getState, hasChanged, hasMixedContent, hasTextIndex, intersection, isCached, isPersistentSet, parentWithChild, parentWithChild, removeDuplicates, selectAncestorDescendant, selectAncestors, selectFollowing, selectFollowingSiblings, selectParentChild, selectParentChild, selectPreceding, selectPrecedingSiblings, setIsCached, setProcessInReverseOrder, toNodeSet, toString, union
 
Methods inherited from class org.exist.xquery.value.AbstractSequence
conversionPreference, convertTo, effectiveBooleanValue, getCardinality, getStringValue, hasMany, setSelfAsContext, toJavaObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.exist.xquery.value.Sequence
conversionPreference, convertTo, effectiveBooleanValue, getCardinality, getStringValue, hasMany, setSelfAsContext, toJavaObject
 

Constructor Detail

SortedNodeSet

public SortedNodeSet(BrokerPool pool,
                     User user,
                     java.lang.String sortExpr,
                     AccessContext accessCtx)
Method Detail

isEmpty

public boolean isEmpty()
Description copied from interface: Sequence
Returns whether the sequence is empty or not.

Specified by:
isEmpty in interface Sequence
Specified by:
isEmpty in class AbstractSequence

hasOne

public boolean hasOne()
Description copied from interface: Sequence
Returns whether the sequence has just one item or not.

Specified by:
hasOne in interface Sequence
Specified by:
hasOne in class AbstractSequence

addAll

public void addAll(Sequence other)
            throws XPathException
Description copied from class: AbstractNodeSet
Add all items from the given sequence to the node set. All items have to be a subtype of node.

Specified by:
addAll in interface Sequence
Overrides:
addAll in class AbstractNodeSet
Parameters:
other -
Throws:
XPathException

addAll

public void addAll(NodeSet other)
Description copied from class: AbstractNodeSet
Add all nodes from the given node set.

Specified by:
addAll in interface NodeSet
Specified by:
addAll in class AbstractNodeSet
Parameters:
other -

addAll

public void addAll(org.w3c.dom.NodeList other)

contains

public boolean contains(NodeProxy proxy)
Description copied from class: AbstractNodeSet
Check if this node set contains a node matching the document and node-id of the given NodeProxy object.

Specified by:
contains in interface NodeSet
Specified by:
contains in class AbstractNodeSet
Parameters:
proxy -

get

public NodeProxy get(int pos)
Description copied from class: AbstractNodeSet
Get the node at position pos within this node set.

Specified by:
get in interface NodeSet
Specified by:
get in class AbstractNodeSet
Parameters:
pos -

get

public NodeProxy get(DocumentImpl doc,
                     NodeId nodeId)

get

public NodeProxy get(NodeProxy proxy)
Description copied from class: AbstractNodeSet
Get a node from this node set matching the document and node id of the given NodeProxy.

Specified by:
get in interface NodeSet
Specified by:
get in class AbstractNodeSet
Parameters:
proxy -

getLength

public int getLength()
Description copied from class: AbstractNodeSet
Return the number of nodes contained in this node set.

Specified by:
getLength in interface Sequence
Specified by:
getLength in class AbstractNodeSet

item

public org.w3c.dom.Node item(int pos)
Specified by:
item in interface org.w3c.dom.NodeList
Specified by:
item in class AbstractNodeSet

itemAt

public Item itemAt(int pos)
Description copied from interface: Sequence
Returns the item located at the specified position within this sequence. Items are counted beginning at 0.

Specified by:
itemAt in interface Sequence
Specified by:
itemAt in class AbstractSequence

iterator

public NodeSetIterator iterator()
Description copied from class: AbstractNodeSet
Return an iterator on the nodes in this list. The iterator returns nodes according to the internal ordering of nodes (i.e. level first), not in document- order.

Specified by:
iterator in interface NodeSet
Specified by:
iterator in class AbstractNodeSet

iterate

public SequenceIterator iterate()
                         throws XPathException
Description copied from interface: Sequence
Returns an iterator over all items in the sequence. The items are returned in document order where applicable.

Specified by:
iterate in interface Sequence
Specified by:
iterate in class AbstractNodeSet
Throws:
XPathException

unorderedIterator

public SequenceIterator unorderedIterator()
Description copied from interface: Sequence
Returns an iterator over all items in the sequence. The returned items may - but need not - to be in document order.

Specified by:
unorderedIterator in interface Sequence
Specified by:
unorderedIterator in class AbstractNodeSet

add

public void add(NodeProxy proxy)
Description copied from class: AbstractNodeSet
Add a new proxy object to the node set. Please note: node set implementations may allow duplicates.

Specified by:
add in interface NodeSet
Specified by:
add in class AbstractNodeSet
Parameters:
proxy -


Copyright (C) Wolfgang Meier. All rights reserved.