com.icl.saxon.expr
Class NodeSetIntent

java.lang.Object
  |
  +--com.icl.saxon.expr.Expression
        |
        +--com.icl.saxon.expr.Value
              |
              +--com.icl.saxon.expr.NodeSetValue
                    |
                    +--com.icl.saxon.expr.NodeSetIntent

public class NodeSetIntent
extends NodeSetValue

A node-set value implemented intensionally. It is a wrapper round an Expression which can be evaluated independently of context, that is it has been reduced so there are no remaining context-dependencies.


Fields inherited from class com.icl.saxon.expr.Value
ANY, BOOLEAN, NODESET, NUMBER, OBJECT, STRING
 
Fields inherited from class com.icl.saxon.expr.Expression
staticContext
 
Constructor Summary
NodeSetIntent(NodeSetExpression exp)
          Construct a node-set containing all the nodes in a NodeEnumeration
 
Method Summary
 java.lang.String asString()
          Convert to string value
 boolean contains(NodeInfo node)
          Determine whether a particular node is present in the nodeset.
 NodeEnumeration enumerate()
          Return an enumeration of this nodeset value.
 int getCount()
          Count the nodes in the node-set.
 NodeInfo getFirst()
          Get the first node in the nodeset (in document order)
 NodeInfo[] getNodes()
          Return the nodes in the node-set as an array.
 NodeSetExpression getNodeSetExpression()
          Get the encapsulated NodeSetExpression
 boolean isEmpty()
          Determine whether the node-set is empty.
 boolean isSorted()
          Test whether the value is known to be sorted
 NodeInfo selectFirst(Context context)
          Return the first node in the nodeset (in document order)
 void setSorted(boolean isSorted)
          Set a flag to indicate whether the nodes are sorted.
 NodeSetValue sort()
          Sort the nodes into document order.
 
Methods inherited from class com.icl.saxon.expr.NodeSetValue
asBoolean, asNumber, compare, enumerate, equals, evaluate, evaluateAsNodeSet, getDataType, isSingular, notEquals
 
Methods inherited from class com.icl.saxon.expr.Value
getDependencies, inverse, numericCompare, reduce, simplify, stringToNumber
 
Methods inherited from class com.icl.saxon.expr.Expression
containsReferences, evaluateAsBoolean, evaluateAsNumber, evaluateAsString, getStaticContext, make, outputStringValue, setStaticContext, usesCurrent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeSetIntent

public NodeSetIntent(NodeSetExpression exp)
              throws org.xml.sax.SAXException
Construct a node-set containing all the nodes in a NodeEnumeration
Method Detail

getNodeSetExpression

public NodeSetExpression getNodeSetExpression()
Get the encapsulated NodeSetExpression

setSorted

public void setSorted(boolean isSorted)
Set a flag to indicate whether the nodes are sorted. Used when the creator of the node-set knows that they are already in document order.
Overrides:
setSorted in class NodeSetValue
Parameters:
isSorted - true if the caller wishes to assert that the nodes will be delivered in document order and do not need to be further sorted

isSorted

public boolean isSorted()
                 throws org.xml.sax.SAXException
Test whether the value is known to be sorted
Overrides:
isSorted in class NodeSetValue
Returns:
true if the value is known to be sorted in document order, false if it is not known whether it is sorted.

asString

public java.lang.String asString()
                          throws org.xml.sax.SAXException
Convert to string value
Overrides:
asString in class NodeSetValue
Returns:
the value of the first node in the node-set if there is one, otherwise an empty string

getCount

public int getCount()
             throws org.xml.sax.SAXException
Count the nodes in the node-set. Note this will sort the node set if necessary, to make sure there are no duplicates.
Overrides:
getCount in class NodeSetValue

isEmpty

public boolean isEmpty()
                throws org.xml.sax.SAXException
Determine whether the node-set is empty.
Overrides:
isEmpty in class NodeSetValue

contains

public boolean contains(NodeInfo node)
                 throws org.xml.sax.SAXException
Determine whether a particular node is present in the nodeset.
Overrides:
contains in class NodeSetValue

getNodes

public NodeInfo[] getNodes()
                    throws org.xml.sax.SAXException
Return the nodes in the node-set as an array. Note that they will only be in sorted order (with duplicates eliminated) if sort() is called first.
Overrides:
getNodes in class NodeSetValue
Returns:
an array containing the NodeInfo objects representing the nodes (possibly unsorted and including duplicates)

sort

public NodeSetValue sort()
                  throws org.xml.sax.SAXException
Sort the nodes into document order. This does nothing if the nodes are already known to be sorted; to force a sort, call setSorted(false)
Overrides:
sort in class NodeSetValue
Returns:
the same NodeSetValue, after sorting.

getFirst

public NodeInfo getFirst()
                  throws org.xml.sax.SAXException
Get the first node in the nodeset (in document order)
Overrides:
getFirst in class NodeSetValue
Returns:
the first node

selectFirst

public NodeInfo selectFirst(Context context)
                     throws org.xml.sax.SAXException
Return the first node in the nodeset (in document order)
Parameters:
context - The context for the evaluation: not used
Returns:
the NodeInfo of the first node in document order, or null if the node-set is empty.

enumerate

public NodeEnumeration enumerate()
                          throws org.xml.sax.SAXException
Return an enumeration of this nodeset value.
Overrides:
enumerate in class NodeSetValue