Package net.sf.saxon.functions

Class Outermost

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Outermost

All Implemented Interfaces:

Callable, FunctionItem, GroundedValue, Item, Sequence

public class Outermost
extends SystemFunction

This class implements the function fn:outermost(), which is a standard function in XPath 3.0

Constructor Summary

Constructors

Constructor	Description
Outermost()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Evaluate the expression in a dynamic call
void	exportAttributes(ExpressionPresenter out)	Export any context attributes held within the SystemFunction object.
int	getSpecialProperties(Expression[] arguments)	Determine the special properties of this function.
String	getStreamerName()	Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser.
void	importAttributes(Properties attributes)	Import any attributes found in the export file, that is, any attributes output using the exportAttributes method
Expression	makeOptimizedFunctionCall(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo, Expression... arguments)	Allow the function to create an optimized call based on the values of the actual arguments

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, fixArguments, getArity, getCardinality, getContextNode, getDescription, getDetails, getElaborator, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getUniStringArg, hashCode, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunction40, makeFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEqual40, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Details

Outermost

public Outermost()

Method Details

makeOptimizedFunctionCall

public Expression makeOptimizedFunctionCall(ExpressionVisitor visitor,
 ContextItemStaticInfo contextInfo,
 Expression... arguments)
                                     throws XPathException

Allow the function to create an optimized call based on the values of the actual arguments

Overrides:

makeOptimizedFunctionCall in class SystemFunction

Parameters:

visitor - the expression visitor

contextInfo - information about the context item

arguments - the supplied arguments to the function call

Returns:

either a function call on this function, or an expression that delivers the same result, or null indicating that no optimization has taken place

Throws:

XPathException - if an error is detected

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Description copied from class: SystemFunction

Determine the special properties of this function. The general rule is that a system function call is non-creative unless more details are defined in a subclass.

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the actual arguments supplied in a call to the function

Returns:

the properties

call

public Sequence call(XPathContext context,
 Sequence[] arguments)
              throws XPathException

Evaluate the expression in a dynamic call

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

exportAttributes

public void exportAttributes(ExpressionPresenter out)

Description copied from class: SystemFunction

Export any context attributes held within the SystemFunction object. The implementation will normally make one or more calls on out.emitAttribute(name, value).

Overrides:

exportAttributes in class SystemFunction

Parameters:

out - the export destination

importAttributes

public void importAttributes(Properties attributes)
                      throws XPathException

Description copied from class: SystemFunction

Import any attributes found in the export file, that is, any attributes output using the exportAttributes method

Overrides:

importAttributes in class SystemFunction

Parameters:

attributes - the attributes, as a properties object

Throws:

XPathException - if errors are found in the SEF file

getStreamerName

public String getStreamerName()

Description copied from class: SystemFunction

Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser. Special streaming support is generally available in Saxon-EE for all system functions that take a sequence as their argument.

Overrides:

getStreamerName in class SystemFunction

Returns:

a name that identifies a class that supports streamed evaluation of this system function, or null if no such class is available. The mapping of names to classes is defined in the Saxon-EE class StreamerMap. In non-streaming Saxon editions (HE and PE) the method always returns null.