Package net.sf.saxon.functions
Class CurrentMergeGroup
java.lang.Object
net.sf.saxon.functions.AbstractFunction
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.CurrentMergeGroup
- All Implemented Interfaces:
Callable
,FunctionItem
,GroundedValue
,Item
,Sequence
Implements the XSLT 3.0 function current-merge-group()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncall
(XPathContext context, Sequence[] arguments) Evaluate the expressionGet the innermost containing xsl:merge instruction, if there is oneDetermine the item type of the value returned by the functionint
getSpecialProperties
(Expression[] arguments) Determine the special properties of this expression.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.boolean
isInLoop()
Determine whether the current-group() function is executed repeatedly within a single iteration of the containing xsl:for-each-groupmakeFunctionCall
(Expression... arguments) Make an expression that either calls this function, or that is equivalent to a call on this functionvoid
setControllingInstruction
(MergeInstr instruction, boolean isInLoop) Set the containing xsl:merge instruction, if there is oneMethods inherited from class net.sf.saxon.functions.SystemFunction
dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getContextNode, getDescription, getDetails, getElaborator, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getUniStringArg, hashCode, importAttributes, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunction40, makeOptimizedFunctionCall, 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
-
CurrentMergeGroup
public CurrentMergeGroup()
-
-
Method Details
-
setControllingInstruction
Set the containing xsl:merge instruction, if there is one- Parameters:
instruction
- the (innermost) containing xsl:merge instructionisInLoop
- true if the current-merge-group() expression is evaluated more than once during evaluation of the body of the xsl:merge instruction
-
getControllingInstruction
Get the innermost containing xsl:merge instruction, if there is one- Returns:
- the innermost containing xsl:merge instruction
-
isInLoop
public boolean isInLoop()Determine whether the current-group() function is executed repeatedly within a single iteration of the containing xsl:for-each-group- Returns:
- true if it is evaluated repeatedly
-
getResultItemType
Determine the item type of the value returned by the function- Overrides:
getResultItemType
in classSystemFunction
- Returns:
- the item type of the result
-
getSpecialProperties
Determine the special properties of this expression.- Overrides:
getSpecialProperties
in classSystemFunction
- Parameters:
arguments
- the actual arguments supplied to the function call- Returns:
StaticProperty.NO_NODES_NEWLY_CREATED
(unless the variable is assignable using saxon:assign)
-
makeFunctionCall
Make an expression that either calls this function, or that is equivalent to a call on this function- Overrides:
makeFunctionCall
in classSystemFunction
- Parameters:
arguments
- the supplied arguments to the function call- Returns:
- either a function call on this function, or an expression that delivers the same result
-
call
Evaluate the expression- Parameters:
context
- the dynamic evaluation contextarguments
- 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
-
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 classSystemFunction
- 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.
-