Package org.apache.xpath.objects
Class XRTreeFrag
java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.objects.XObject
org.apache.xpath.objects.XRTreeFrag
- All Implemented Interfaces:
Serializable
,Cloneable
,SourceLocator
,ExpressionNode
,XPathVisitable
- Direct Known Subclasses:
XRTreeFragSelectWrapper
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:
-
Field Summary
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
ConstructorsConstructorDescriptionXRTreeFrag
(int root, XPathContext xctxt) Create an XRTreeFrag Object.XRTreeFrag
(int root, XPathContext xctxt, ExpressionNode parent) Create an XRTreeFrag Object.XRTreeFrag
(Expression expr) Create an XRTreeFrag Object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
allowDetachToRelease
(boolean allowRelease) Specify if it's OK for detach to release the iterator for reuse.void
Cast result object to a string.Cast result object to a DTMIterator.boolean
bool()
Cast result object to a boolean.Cast result object to a nodelist.void
detach()
Detaches theDTMIterator
from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.boolean
Tell if two objects are functionally equal.int
getType()
Tell what kind of class this is.Given a request type, return the equivalent string.double
num()
Cast result object to a number.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.str()
Cast result object to a string.xstr()
Cast result object to an XMLString.Methods inherited from class org.apache.xpath.objects.XObject
boolWithSideEffects, callVisitors, castToType, create, create, deepEquals, destruct, dispatchCharactersEvents, execute, fixupVariables, getFresh, greaterThan, greaterThanOrEqual, iter, lessThan, lessThanOrEqual, mutableNodeset, nodelist, nodeset, notEquals, numWithSideEffects, reset, rtf, rtree, rtree, toString
Methods inherited from class org.apache.xpath.Expression
asIterator, asIteratorRaw, asNode, assertion, bool, canTraverseOutsideSubtree, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isStableNumber, num, warn, xstr
-
Constructor Details
-
XRTreeFrag
Create an XRTreeFrag Object. -
XRTreeFrag
Create an XRTreeFrag Object. -
XRTreeFrag
Create an XRTreeFrag Object.
-
-
Method Details
-
object
Return a java object that's closest to the representation that should be handed to an extension. -
allowDetachToRelease
public void allowDetachToRelease(boolean allowRelease) Specify if it's OK for detach to release the iterator for reuse.- Overrides:
allowDetachToRelease
in classXObject
- Parameters:
allowRelease
- true if it is OK for detach to release this iterator for pooling.
-
detach
public void detach()Detaches theDTMIterator
from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. Afterdetach
has been invoked, calls tonextNode
orpreviousNode
will raise a runtime exception. In general, detach should only be called once on the object. -
getType
public int getType()Tell what kind of class this is. -
getTypeString
Given a request type, return the equivalent string. For diagnostic purposes.- Overrides:
getTypeString
in classXObject
- Returns:
- type string "#RTREEFRAG"
-
num
Cast result object to a number.- Overrides:
num
in classXObject
- Returns:
- The result tree fragment as a number or NaN
- Throws:
TransformerException
-
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. -
xstr
Cast result object to an XMLString. -
appendToFsb
Cast result object to a string.- Overrides:
appendToFsb
in classXObject
-
str
Cast result object to a string. -
rtf
public int rtf()Cast result object to a result tree fragment. -
asNodeIterator
Cast result object to a DTMIterator. dml - modified to return an RTFIterator for benefit of EXSLT object-type function inExsltCommon
.- Returns:
- The document fragment as a DTMIterator
-
convertToNodeset
Cast result object to a nodelist. (special function).- Returns:
- The document fragment as a nodelist
-
equals
Tell if two objects are functionally equal.- Overrides:
equals
in classXObject
- Parameters:
obj2
- Object to compare this to- Returns:
- True if the two objects are equal
- Throws:
TransformerException
-