Package net.sf.saxon.functions

Class Idref

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Idref

All Implemented Interfaces:

Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class Idref
extends SystemFunction

Constructor Summary

Constructors

Constructor	Description
Idref()

Method Summary

Modifier and Type	Method	Description
Sequence<?>	call(XPathContext context, Sequence[] arguments)	Evaluate the expression
static SequenceIterator<NodeInfo>	getIdrefMultiple(TreeInfo doc, SequenceIterator<StringValue> keys, XPathContext context)	Get the result when multiple idref values are supplied.
int	getSpecialProperties(Expression[] arguments)	Get the static properties of this expression (other than its type).

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, 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

getGenre

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

asIterable, materialize

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

makeRepeatable

Constructor Details

Idref

public Idref()

Method Details

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

getIdrefMultiple

public static SequenceIterator<NodeInfo> getIdrefMultiple(TreeInfo doc,
 SequenceIterator<StringValue> keys,
 XPathContext context)
                                                   throws XPathException

Get the result when multiple idref values are supplied. Note this is also called from compiled XQuery code.

Parameters:

doc - the document to be searched

keys - the idref values supplied

context - the dynamic execution context

Returns:

iterator over the result of the function

Throws:

XPathException - if a dynamic error occurs

call

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

Evaluate the expression

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as SequenceIterators

Returns:

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

Throws:

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