Package com.saxonica.ee.stream

Class StreamableUserFunction

java.lang.Object

net.sf.saxon.expr.instruct.Actor

net.sf.saxon.expr.instruct.UserFunction

com.saxonica.ee.stream.StreamableUserFunction

All Implemented Interfaces:

SourceLocator, Callable, ContextOriginator, ExpressionOwner, Locatable, FunctionDefinition, FunctionItem, GroundedValue, Item, Sequence, Location, Traceable, TraceableComponent, Locator

public class StreamableUserFunction
extends UserFunction

Represents a used-defined XSLT function whose declared streamability is other than "unclassified"

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.expr.instruct.UserFunction

UserFunction.Determinism

Field Summary

Fields inherited from class net.sf.saxon.expr.instruct.UserFunction

bodyEvaluator, pushEvaluator

Fields inherited from class net.sf.saxon.expr.instruct.Actor

body

Constructor Summary

Constructors

Constructor	Description
StreamableUserFunction()

Method Summary

Modifier and Type	Method	Description
ComponentInversion	getInversion()
void	makeInversion()	Generate the inversion of the expression comprising the body of the function.
void	prepareForStreaming()

Methods inherited from class net.sf.saxon.expr.instruct.UserFunction

acceptsNodesWithoutAtomization, atomize, call, call, callUpdating, computeEvaluationMode, containsTailCalls, deepEqual40, deepEquals, effectiveBooleanValue, export, gatherProperties, getAnnotations, getArgumentType, getArity, getBodyEvaluator, getDeclaredResultType, getDeclaredStreamability, getDefaultValueExpression, getDescription, getDeterminism, getFunctionItemType, getFunctionItemType, getFunctionName, getLength, getMinimumArity, getNumberOfParameters, getObjectName, getOperandRoles, getParameterDefinitions, getParameterName, getPositionOfParameter, getReferenceCount, getResultType, getSymbolicName, getTracingTag, getUnicodeStringValue, head, incrementReferenceCount, isArray, isExportable, isInlineable, isMap, isMemoFunction, isOverrideExtensionFunction, isTailRecursive, isTrustedResultType, isUpdating, itemAt, makeExpandedArgumentArray, makeNewContext, markAsInlined, process, reduce, setAnnotations, setArityRange, setBodyEvaluator, setDeclaredStreamability, setDeterminism, setFunctionName, setInlineable, setIxslUpdating, setMinimumArity, setOverrideExtensionFunction, setParameterDefinitions, setResultType, setTailRecursive, setUpdating, subsequence, typeCheck

Methods inherited from class net.sf.saxon.expr.instruct.Actor

allocateAllBindingSlots, allocateBindingSlotsRecursive, getBody, getChildExpression, getColumnNumber, getComponentName, getDeclaredVisibility, getDeclaringComponent, getLineNumber, getLocation, getPackageData, getProperty, getPublicId, getRetainedStaticContext, getStackFrameMap, getSystemId, makeDeclaringComponent, obtainDeclaringComponent, process, saveLocation, setBody, setChildExpression, setColumnNumber, setDeclaredVisibility, setDeclaringComponent, setLineNumber, setPackageData, setRetainedStaticContext, setStackFrameMap, setSystemId

Methods inherited from class java.lang.Object

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

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

getGenre, isSequenceVariadic, toShortString

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

asIterable, concatenate, containsNode, materialize

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

getStringValue, isStreamed, iterate

Methods inherited from interface net.sf.saxon.expr.Locatable

getLocation

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

makeRepeatable

Methods inherited from interface net.sf.saxon.trace.TraceableComponent

getBody, setBody

Constructor Details

StreamableUserFunction

public StreamableUserFunction()

Method Details

makeInversion

public void makeInversion()
                   throws XPathException

Generate the inversion of the expression comprising the body of the function. Supported in Saxon-EE only

Throws:

XPathException

getInversion

public ComponentInversion getInversion()

prepareForStreaming

public void prepareForStreaming()
                         throws XPathException

Overrides:

prepareForStreaming in class UserFunction

Throws:

XPathException