net.sf.saxon.functions

Class GenerateId_1

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.ScalarSystemFunction

net.sf.saxon.functions.GenerateId_1

All Implemented Interfaces:

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

public class GenerateId_1
extends ScalarSystemFunction

This class supports the generate-id() function with one argument

Field Summary

Fields inherited from class net.sf.saxon.functions.ScalarSystemFunction

ZERO_LENGTH_STRING

Constructor Summary

Constructors

Constructor and Description
GenerateId_1()

Method Summary

Modifier and Type	Method and Description
AtomicValue	evaluate(Item arg, XPathContext context) Abstract method that must be supplied in subclasses to perform the evaluation
static StringValue	generateId(NodeInfo node)
java.lang.String	getCompilerName() Get the (local) name of a class that can be used to generate bytecode for this system function
int	getSpecialProperties(Expression[] arguments) Determine the special properties of this expression.
ZeroOrOne<? extends AtomicValue>	resultWhenEmpty() Method that may be supplied in subclasses, to indicate the result that is returned when an empty sequence is supplied as the argument value.

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

call, makeFunctionCall

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

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

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

GenerateId_1

public GenerateId_1()

Method Detail

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Determine the special properties of this expression. The generate-id() function is a special case: it is considered creative if its operand is creative, so that generate-id(f()) is not taken out of a loop

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the expressions supplied as arguments in the function call

resultWhenEmpty

public ZeroOrOne<? extends AtomicValue> resultWhenEmpty()

Description copied from class: ScalarSystemFunction

Method that may be supplied in subclasses, to indicate the result that is returned when an empty sequence is supplied as the argument value. The default is to return the empty sequence

Overrides:

resultWhenEmpty in class ScalarSystemFunction

Returns:

the result of evaluation when the supplied argument is an empty sequence

evaluate

public AtomicValue evaluate(Item arg,
                            XPathContext context)
                     throws XPathException

Description copied from class: ScalarSystemFunction

Abstract method that must be supplied in subclasses to perform the evaluation

Specified by:

evaluate in class ScalarSystemFunction

Parameters:

arg - the supplied argument

context - the dynamic context

Returns:

the result of the evaluation

Throws:

XPathException - if a dynamic error occurs

generateId

public static StringValue generateId(NodeInfo node)

getCompilerName

public java.lang.String getCompilerName()

Description copied from class: SystemFunction

Get the (local) name of a class that can be used to generate bytecode for this system function

Overrides:

getCompilerName in class SystemFunction

Returns:

the name of a bytecode generation class, or null if there is no bytecode support for this function