net.sf.saxon.functions

Class Innermost

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Innermost

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class Innermost
extends SystemFunction

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

Constructor Summary

Constructors

Constructor and Description
Innermost()

Method Summary

Modifier and Type	Method and Description
Sequence<? extends NodeInfo>	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.
void	importAttributes(java.util.Properties attributes) Import any attributes found in the export file, that is, any attributes output using the exportAttributes method
SequenceIterator<? extends NodeInfo>	innermost(SequenceIterator<? extends NodeInfo> in)
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, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamerName, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

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

argumentArray, getGenre

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

getLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

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

asIterable, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Innermost

public Innermost()

Method Detail

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

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. Note: modifying the contents of this array should not be attempted, it is likely to have no effect.

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

call

public Sequence<? extends NodeInfo> 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

innermost

public SequenceIterator<? extends NodeInfo> innermost(SequenceIterator<? extends NodeInfo> in)
                                               throws XPathException

Throws:

XPathException

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(java.util.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