org.apache.xalan.xpath
Class XNodeSet

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.objects.XObject
              |
              +--org.apache.xalan.xpath.XObject
                    |
                    +--org.apache.xalan.xpath.XNodeSet

public class XNodeSet
extends XObject

This class represents an XPath nodeset object, and is capable of converting the nodeset to other types, such as a string.

See Also:
Serialized Form

Fields inherited from class org.apache.xpath.objects.XObject
CLASS_BOOLEAN, CLASS_NODESET, CLASS_NULL, CLASS_NUMBER, CLASS_RTREEFRAG, CLASS_STRING, CLASS_UNKNOWN, CLASS_UNRESOLVEDVARIABLE
 
Constructor Summary
XNodeSet()
          Construct an empty XNodeSet object.
XNodeSet(org.w3c.dom.Node n)
          Construct a XNodeSet object for one node.
XNodeSet(org.w3c.dom.NodeList val)
          Construct a XNodeSet object.
 
Method Summary
 boolean bool()
          Cast result object to a boolean.
 boolean equals(XObject obj2)
          Tell if two objects are functionally equal.
 int getType()
          Tell that this is a CLASS_NODESET.
 java.lang.String getTypeString()
          Given a request type, return the equivalent string.
 boolean greaterThan(XObject obj2)
          Tell if one object is greater than the other.
 boolean greaterThanOrEqual(XObject obj2)
          Tell if one object is greater than the other.
 boolean lessThan(XObject obj2)
          Tell if one object is less than the other.
 boolean lessThanOrEqual(XObject obj2)
          Tell if one object is less than or equal to the other.
 org.apache.xpath.NodeSet mutableNodeset()
          Cast result object to a nodelist.
 org.w3c.dom.traversal.NodeIterator nodeset()
          Cast result object to a nodelist.
 boolean notEquals(XObject obj2)
          Tell if two objects are functionally not equal.
 double num()
          Cast result object to a number.
 org.w3c.dom.DocumentFragment rtree(org.apache.xpath.XPathContext support)
          Cast result object to a result tree fragment.
 org.w3c.dom.DocumentFragment rtree(XPathSupport support)
          Cast result object to a result tree fragment.
 java.lang.String str()
          Cast result object to a string.
 
Methods inherited from class org.apache.xpath.objects.XObject
castToType, create, equals, execute, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEquals, object, rtree, toString
 
Methods inherited from class org.apache.xpath.Expression
assertion, canTraverseOutsideSubtree, error, setSourceLocator, warn
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XNodeSet

public XNodeSet(org.w3c.dom.NodeList val)
Construct a XNodeSet object.

XNodeSet

public XNodeSet()
Construct an empty XNodeSet object.

XNodeSet

public XNodeSet(org.w3c.dom.Node n)
Construct a XNodeSet object for one node.
Method Detail

getType

public int getType()
Tell that this is a CLASS_NODESET.
Overrides:
getType in class org.apache.xpath.objects.XObject

getTypeString

public java.lang.String getTypeString()
Given a request type, return the equivalent string. For diagnostic purposes.
Overrides:
getTypeString in class org.apache.xpath.objects.XObject

num

public double num()
Cast result object to a number.
Overrides:
num in class org.apache.xpath.objects.XObject

bool

public boolean bool()
Cast result object to a boolean.
Overrides:
bool in class org.apache.xpath.objects.XObject

str

public java.lang.String str()
Cast result object to a string.
Overrides:
str in class org.apache.xpath.objects.XObject

rtree

public org.w3c.dom.DocumentFragment rtree(XPathSupport support)
Cast result object to a result tree fragment.

rtree

public org.w3c.dom.DocumentFragment rtree(org.apache.xpath.XPathContext support)
Cast result object to a result tree fragment.
Overrides:
rtree in class org.apache.xpath.objects.XObject
Parameters:
support - The XPath context to use for the conversion
Returns:
the nodeset as a result tree fragment.

nodeset

public org.w3c.dom.traversal.NodeIterator nodeset()
Cast result object to a nodelist.
Overrides:
nodeset in class org.apache.xpath.objects.XObject

mutableNodeset

public org.apache.xpath.NodeSet mutableNodeset()
Cast result object to a nodelist.
Overrides:
mutableNodeset in class org.apache.xpath.objects.XObject

lessThan

public boolean lessThan(XObject obj2)
                 throws org.xml.sax.SAXException,
                        javax.xml.transform.TransformerException
Tell if one object is less than the other.

lessThanOrEqual

public boolean lessThanOrEqual(XObject obj2)
                        throws org.xml.sax.SAXException,
                               javax.xml.transform.TransformerException
Tell if one object is less than or equal to the other.

greaterThan

public boolean greaterThan(XObject obj2)
                    throws org.xml.sax.SAXException,
                           javax.xml.transform.TransformerException
Tell if one object is greater than the other.

greaterThanOrEqual

public boolean greaterThanOrEqual(XObject obj2)
                           throws org.xml.sax.SAXException,
                                  javax.xml.transform.TransformerException
Tell if one object is greater than the other.

equals

public boolean equals(XObject obj2)
               throws org.xml.sax.SAXException,
                      javax.xml.transform.TransformerException
Tell if two objects are functionally equal.

notEquals

public boolean notEquals(XObject obj2)
                  throws org.xml.sax.SAXException,
                         javax.xml.transform.TransformerException
Tell if two objects are functionally not equal.


Copyright © 2000 Apache XML Project. All Rights Reserved.