org.apache.xpath.objects
Class XRTreeFrag

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

public class XRTreeFrag

extends XObject

This class represents an XPath result tree fragment object, and is capable of converting the RTF 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

XRTreeFrag(DocumentFragment frag)
Create an XRTreeFrag Object.

Method Summary

NodeIterator	asNodeIterator() Cast result object to a NodeIterator.
boolean	bool() Cast result object to a boolean.
NodeList	convertToNodeset() Cast result object to a nodelist.
boolean	equals(XObject obj2) Tell if two objects are functionally equal.
int	getType() Tell what kind of class this is.
java.lang.String	getTypeString() Given a request type, return the equivalent string.
double	num() Cast result object to a number.
DocumentFragment	rtree() 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, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, mutableNodeset, nodeset, notEquals, object, rtree, toString

Methods inherited from class org.apache.xpath.Expression

assert, canTraverseOutsideSubtree, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XRTreeFrag

public XRTreeFrag(DocumentFragment frag)

Create an XRTreeFrag Object.

Parameters:

frag - Document fragment this will wrap

Method Detail

getType

public int getType()

Tell what kind of class this is.

Returns:

type CLASS_RTREEFRAG

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 "#RTREEFRAG"

Overrides:

getTypeString in class XObject

num

public double num()

Cast result object to a number.

Returns:

The result tree fragment as a number or NaN

Overrides:

num in class XObject

bool

public boolean bool()

Cast result object to a boolean. This always returns true for a RTreeFrag because it is treated like a node-set with a single root node.

Returns:

true

Overrides:

bool in class XObject

str

public java.lang.String str()

Cast result object to a string.

Returns:

The document fragment node data or the empty string.

Overrides:

str in class XObject

rtree

public DocumentFragment rtree()

Cast result object to a result tree fragment.

Returns:

The document fragment this wraps

Overrides:

rtree in class XObject

asNodeIterator

public NodeIterator asNodeIterator()

Cast result object to a NodeIterator.

Returns:

The document fragment as a NodeIterator

convertToNodeset

public NodeList convertToNodeset()

Cast result object to a nodelist. (special function).

Returns:

The document fragment as a nodelist

equals

public boolean equals(XObject obj2)
               throws TransformerException

Tell if two objects are functionally equal.

Parameters:

obj2 - Object to compare this to

Returns:

True if the two objects are equal

Throws:

TransformerException -

Overrides:

equals in class XObject