net.sf.saxon.functions

Class Root_1

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Root_1

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class Root_1
extends SystemFunction

Implement the XPath 2.0 root() function with one argument

Constructor Summary

Constructors

Constructor and Description
Root_1()

Method Summary

Methods

Modifier and Type	Method and Description
ZeroOrOne<NodeInfo>	call(XPathContext context, Sequence[] arguments) Evaluate the expression
ExpressionCompiler	getExpressionCompiler() Return the compiler of the Root Function
int	getSpecialProperties(Expression[] arguments) Get the static properties of this expression (other than its type).
StreamingAdjunct	getStreamingAdjunct() Get a class that supports streamed evaluation of this expression

Methods inherited from class net.sf.saxon.functions.SystemFunction

equals, export, exportAttributes, getArity, getCardinality, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, importAttributes, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

iterate

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.GroundedValue

getLength, head, itemAt, reduce, subsequence

Constructor Detail

Root_1

public Root_1()

Method Detail

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Get the static properties of this expression (other than its type). The result is bit-significant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the actual arguments to the function call

call

public ZeroOrOne<NodeInfo> call(XPathContext context,
                       Sequence[] arguments)
                         throws XPathException

Evaluate the expression

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences

Returns:

the result of the evaluation, in the form of a Sequence

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

getStreamingAdjunct

public StreamingAdjunct getStreamingAdjunct()

Get a class that supports streamed evaluation of this expression

Overrides:

getStreamingAdjunct in class SystemFunction

Returns:

the relevant StreamingAdjunct, or null if none is available

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the Root Function

Overrides:

getExpressionCompiler in class SystemFunction

Returns:

the relevant ExpressionCompiler