org.apache.xpath.objects

Class XRTreeFragSelectWrapper

Implemented Interfaces:
Cloneable, Serializable, ExpressionNode, SourceLocator, XPathVisitable

public class XRTreeFragSelectWrapper
extends XRTreeFrag
implements Cloneable

This class makes an select statement act like an result tree fragment.
See Also:
Serialized Form

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

XRTreeFragSelectWrapper(Expression expr)
Create an XRTreeFrag Object.

Method Summary

DTMIterator
asNodeIterator()
Cast result object to a DTMIterator.
void
detach()
Detaches the DTMIterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.
XObject
execute(XPathContext xctxt)
For support of literal objects in xpaths.
void
fixupVariables(java.util.Vector vars, int globalsSize)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
int
getType()
Tell what kind of class this is.
double
num()
Cast result object to a number.
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.

Methods inherited from class org.apache.xpath.objects.XRTreeFrag

allowDetachToRelease, appendToFsb, asNodeIterator, bool, convertToNodeset, detach, equals, getType, getTypeString, num, object, rtf, str, xstr

Methods inherited from class org.apache.xpath.objects.XObject

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

Methods inherited from class org.apache.xpath.Expression

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

Constructor Details

XRTreeFragSelectWrapper

public XRTreeFragSelectWrapper(Expression expr)
Create an XRTreeFrag Object.

Method Details

asNodeIterator

public DTMIterator asNodeIterator()
Cast result object to a DTMIterator.
Overrides:
asNodeIterator in interface XRTreeFrag
Returns:
The document fragment as a DTMIterator

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.
Overrides:
detach in interface XRTreeFrag

execute

public XObject execute(XPathContext xctxt)
            throws javax.xml.transform.TransformerException
For support of literal objects in xpaths.
Overrides:
execute in interface XObject
Parameters:
xctxt - The XPath execution context.
Returns:
the result of executing the select expression

fixupVariables

public void fixupVariables(java.util.Vector vars,
                           int globalsSize)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Overrides:
fixupVariables in interface XObject
Parameters:
vars - List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).

getType

public int getType()
Tell what kind of class this is.
Overrides:
getType in interface XRTreeFrag
Returns:
the string type

num

public double num()
            throws javax.xml.transform.TransformerException
Cast result object to a number.
Overrides:
num in interface XRTreeFrag
Returns:
The result tree fragment as a number or NaN

rtf

public int rtf()
Cast result object to a result tree fragment.
Overrides:
rtf in interface XRTreeFrag
Returns:
The document fragment this wraps

str

public String str()
Cast result object to a string.
Overrides:
str in interface XRTreeFrag
Returns:
The document fragment node data or the empty string.

xstr

public XMLString xstr()
Cast result object to an XMLString.
Overrides:
xstr in interface XRTreeFrag
Returns:
The document fragment node data or the empty string.

Copyright B) 2006 Apache XML Project. All Rights Reserved.