org.apache.xpath.objects
Class XNodeSet

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.objects.XObject
              |
              +--org.apache.xpath.objects.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(Node n)
Construct a XNodeSet object for one node.

XNodeSet(NodeIterator val)
Construct a XNodeSet object.

Method Summary

boolean	bool() Cast result object to a boolean.
boolean	compare(XObject obj2, org.apache.xpath.objects.Comparator comparator) Tell if one object is less than the other.
boolean	equals(XObject obj2) Tell if two objects are functionally equal.
static double	getNumberFromNode(Node n) Get numeric value of the string conversion from a single node.
static java.lang.String	getStringFromNode(Node n) Get the string conversion from a single node.
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 less than the other.
boolean	greaterThanOrEqual(XObject obj2) Tell if one object is less 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.
NodeSet	mutableNodeset() Cast result object to a mutableNodeset.
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.
DocumentFragment	rtree(XPathContext 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, execute, 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(NodeIterator val)

Construct a XNodeSet object.

Parameters:

val - Value of the XNodeSet object

XNodeSet

public XNodeSet()

Construct an empty XNodeSet object.

XNodeSet

public XNodeSet(Node n)

Construct a XNodeSet object for one node.

Parameters:

n - Node to add to the new XNodeSet object

Method Detail

getType

public int getType()

Tell that this is a CLASS_NODESET.

Returns:

type CLASS_NODESET

Overrides:

getType in class XObject

getTypeString

public java.lang.String getTypeString()

Given a request type, return the equivalent string. For diagnostic purposes.

Returns:

type string "#NODESET"

Overrides:

getTypeString in class XObject

getNumberFromNode

public static double getNumberFromNode(Node n)

Get numeric value of the string conversion from a single node.

Parameters:

n - Node to convert

Returns:

numeric value of the string conversion from a single node.

num

public double num()

Cast result object to a number.

Returns:

numeric value of the string conversion from the next node in the NodeSet, or NAN if no node was found

Overrides:

num in class XObject

bool

public boolean bool()

Cast result object to a boolean.

Returns:

True if there is a next node in the nodeset

Overrides:

bool in class XObject

getStringFromNode

public static java.lang.String getStringFromNode(Node n)

Get the string conversion from a single node.

Parameters:

n - Node to convert

Returns:

the string conversion from a single node.

str

public java.lang.String str()

Cast result object to a string.

Returns:

the string conversion from the next node in the nodeset or "" if there is no next node

Overrides:

str in class XObject

rtree

public DocumentFragment rtree(XPathContext support)

Cast result object to a result tree fragment.

Parameters:

support - The XPath context to use for the conversion

Returns:

the nodeset as a result tree fragment.

Overrides:

rtree in class XObject

nodeset

public NodeIterator nodeset()

Cast result object to a nodelist.

Returns:

The nodeset as a nodelist

Overrides:

nodeset in class XObject

mutableNodeset

public NodeSet mutableNodeset()

Cast result object to a mutableNodeset.

Returns:

The nodeset as a mutableNodeset

Overrides:

mutableNodeset in class XObject

compare

public boolean compare(XObject obj2,
                       org.apache.xpath.objects.Comparator comparator)
                throws TransformerException

Tell if one object is less than the other.

Parameters:

obj2 - Object to compare this nodeset to

comparator - Comparator to use

Returns:

See the comments below for each object type comparison

Throws:

TransformerException -

lessThan

public boolean lessThan(XObject obj2)
                 throws TransformerException

Tell if one object is less than the other.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

lessThan in class XObject

lessThanOrEqual

public boolean lessThanOrEqual(XObject obj2)
                        throws TransformerException

Tell if one object is less than or equal to the other.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

lessThanOrEqual in class XObject

greaterThan

public boolean greaterThan(XObject obj2)
                    throws TransformerException

Tell if one object is less than the other.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

greaterThan in class XObject

greaterThanOrEqual

public boolean greaterThanOrEqual(XObject obj2)
                           throws TransformerException

Tell if one object is less than the other.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

greaterThanOrEqual in class XObject

equals

public boolean equals(XObject obj2)
               throws TransformerException

Tell if two objects are functionally equal.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

equals in class XObject

notEquals

public boolean notEquals(XObject obj2)
                  throws TransformerException

Tell if two objects are functionally not equal.

Parameters:

obj2 - object to compare this nodeset to

Returns:

see this.compare(...)

Throws:

TransformerException -

Overrides:

notEquals in class XObject