com.icl.saxon.expr
Class SingletonNodeSet

java.lang.Object
  |
  +--com.icl.saxon.expr.Expression
        |
        +--com.icl.saxon.expr.Value
              |
              +--com.icl.saxon.expr.NodeSetValue
                    |
                    +--com.icl.saxon.expr.SingletonNodeSet
Direct Known Subclasses:
FragmentValue

public class SingletonNodeSet
extends NodeSetValue

A node-set value containing zero or one nodes


Field Summary
protected  NodeInfo node
           
 
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
SingletonNodeSet()
          Create an empty node-set
SingletonNodeSet(NodeInfo node)
          Create a node-set containing one node
 
Method Summary
 boolean asBoolean()
          Evaluate as a boolean.
 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.
 boolean equals(Value other)
          Test whether a nodeset "equals" another Value
 Value evaluate(Context context)
          Evaluate the Node Set.
 NodeSetValue evaluateAsNodeSet(Context context)
          Evaluate an expression as a NodeSet.
 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.
 boolean isEmpty()
          Determine whether the node-set is empty.
 boolean isSingular()
          Determine whether the node-set is singular, that is, whether it has a single member.
 boolean isSorted()
          Test whether the value is known to be sorted
 boolean notEquals(Value other)
          Test whether a nodeset "not-equals" another Value
 void setSorted(boolean isSorted)
          Set a flag to indicate whether the nodes are sorted.
 Expression simplify()
          Simplify the expression
 NodeSetValue sort()
          Sort the nodes into document order.
 
Methods inherited from class com.icl.saxon.expr.NodeSetValue
asNumber, compare, enumerate, getDataType
 
Methods inherited from class com.icl.saxon.expr.Value
getDependencies, inverse, numericCompare, reduce, 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
 

Field Detail

node

protected NodeInfo node
Constructor Detail

SingletonNodeSet

public SingletonNodeSet()
Create an empty node-set

SingletonNodeSet

public SingletonNodeSet(NodeInfo node)
Create a node-set containing one node
Method Detail

simplify

public Expression simplify()
                    throws org.xml.sax.SAXException
Simplify the expression
Overrides:
simplify in class Value
Following copied from class: com.icl.saxon.expr.Value
Returns:
the simplified expression

evaluate

public Value evaluate(Context context)
               throws org.xml.sax.SAXException
Evaluate the Node Set. This guarantees to return the result in sorted order.
Overrides:
evaluate in class NodeSetValue
Parameters:
context - The context for evaluation (not used)

evaluateAsNodeSet

public NodeSetValue evaluateAsNodeSet(Context context)
                               throws org.xml.sax.SAXException
Evaluate an expression as a NodeSet.
Overrides:
evaluateAsNodeSet in class NodeSetValue
Parameters:
context - The context in which the expression is to be evaluated
Returns:
the value of the expression, evaluated in the current context

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 are in document order and do not need to be further sorted

isSorted

public boolean isSorted()
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

asBoolean

public boolean asBoolean()
                  throws org.xml.sax.SAXException
Evaluate as a boolean.
Overrides:
asBoolean in class NodeSetValue
Returns:
true if the node set is not empty

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. This is more efficient than testing getCount()==0, because it doesn't risk triggering a sort.
Overrides:
isEmpty in class NodeSetValue

isSingular

public boolean isSingular()
                   throws org.xml.sax.SAXException
Determine whether the node-set is singular, that is, whether it has a single member. This is more efficient that testing getCount()==1, because it doesn't risk triggering a sort.
Overrides:
isSingular 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()
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. (Historic)

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

equals

public boolean equals(Value other)
               throws org.xml.sax.SAXException
Test whether a nodeset "equals" another Value
Overrides:
equals in class NodeSetValue
Following copied from class: com.icl.saxon.expr.Value
Returns:
a boolean giving the value of the expression, evaluated in the current context

notEquals

public boolean notEquals(Value other)
                  throws org.xml.sax.SAXException
Test whether a nodeset "not-equals" another Value
Overrides:
notEquals in class NodeSetValue
Following copied from class: com.icl.saxon.expr.Value
Returns:
a boolean giving the value of the expression, evaluated in the current context

enumerate

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