org.apache.xpath.objects
Class XRTreeFrag
- Cloneable, Serializable, ExpressionNode, SourceLocator, XPathVisitable
public class XRTreeFrag
implements Cloneable
This class represents an XPath result tree fragment object, and is capable of
converting the RTF to other types, such as a string.
void | allowDetachToRelease(boolean allowRelease) - Specify if it's OK for detach to release the iterator for reuse.
|
void | appendToFsb(FastStringBuffer fsb) - Cast result object to a string.
|
DTMIterator | asNodeIterator() - Cast result object to a DTMIterator.
|
boolean | bool() - Cast result object to a boolean.
|
NodeList | convertToNodeset() - Cast result object to a nodelist. (special function).
|
void | destruct() - Forces the object to release it's resources.
|
void | detach() - Detaches the
DTMIterator from the set which it iterated
over, releasing any computational resources and placing the iterator
in the INVALID state.
|
boolean | equals(XObject obj2) - Tell if two objects are functionally equal.
|
int | getType() - Tell what kind of class this is.
|
String | getTypeString() - Given a request type, return the equivalent string.
|
double | num() - Cast result object to a number.
|
Object | object() - Return a java object that's closest to the representation
that should be handed to an extension.
|
int | rtf() - Cast result object to a result tree fragment.
|
String | str() - Cast result object to a string.
|
XMLString | xstr() - Cast result object to an XMLString.
|
allowDetachToRelease , appendToFsb , bool , boolWithSideEffects , callVisitors , castToType , create , create , deepEquals , destruct , detach , dispatchCharactersEvents , equals , execute , fixupVariables , getFresh , getType , getTypeString , greaterThan , greaterThanOrEqual , iter , lessThan , lessThanOrEqual , mutableNodeset , nodelist , nodeset , notEquals , num , numWithSideEffects , object , reset , rtf , rtf , rtree , rtree , str , toString , xstr |
asIterator , asIteratorRaw , asNode , assertion , bool , canTraverseOutsideSubtree , deepEquals , error , execute , execute , execute , execute , executeCharsToContentHandler , exprAddChild , exprGetChild , exprGetNumChildren , exprGetParent , exprSetParent , fixupVariables , getColumnNumber , getExpressionOwner , getLineNumber , getPublicId , getSystemId , isNodesetExpr , isStableNumber , num , warn , xstr |
XRTreeFrag
public XRTreeFrag(int root,
XPathContext xctxt)
Create an XRTreeFrag Object.
XRTreeFrag
public XRTreeFrag(Expression expr)
Create an XRTreeFrag Object.
allowDetachToRelease
public void allowDetachToRelease(boolean allowRelease)
Specify if it's OK for detach to release the iterator for reuse.
- allowDetachToRelease in interface XObject
allowRelease
- true if it is OK for detach to release this iterator
for pooling.
asNodeIterator
public DTMIterator asNodeIterator()
Cast result object to a DTMIterator.
dml - modified to return an RTFIterator for
benefit of EXSLT object-type function in
ExsltCommon
.
- The document fragment as a DTMIterator
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.
- bool in interface XObject
convertToNodeset
public NodeList convertToNodeset()
Cast result object to a nodelist. (special function).
- The document fragment as a nodelist
destruct
public void destruct()
Forces the object to release it's resources. This is more harsh than
detach(). You can call destruct as many times as you want.
- destruct in interface XObject
detach
public void detach()
Detaches the DTMIterator
from the set which it iterated
over, releasing any computational resources and placing the iterator
in the INVALID state. After detach
has been invoked,
calls to nextNode
or previousNode
will
raise a runtime exception.
In general, detach should only be called once on the object.
- detach in interface XObject
equals
public boolean equals(XObject obj2)
Tell if two objects are functionally equal.
- equals in interface XObject
obj2
- Object to compare this to
- True if the two objects are equal
getType
public int getType()
Tell what kind of class this is.
- getType in interface XObject
getTypeString
public String getTypeString()
Given a request type, return the equivalent string.
For diagnostic purposes.
- getTypeString in interface XObject
num
public double num()
throws TransformerException
Cast result object to a number.
- num in interface XObject
- The result tree fragment as a number or NaN
object
public Object object()
Return a java object that's closest to the representation
that should be handed to an extension.
- object in interface XObject
- The object that this class wraps
rtf
public int rtf()
Cast result object to a result tree fragment.
- rtf in interface XObject
- The document fragment this wraps
str
public String str()
Cast result object to a string.
- str in interface XObject
- The document fragment node data or the empty string.
xstr
public XMLString xstr()
Cast result object to an XMLString.
- xstr in interface XObject
- The document fragment node data or the empty string.
Copyright B) 2004 Apache XML Project. All Rights Reserved.