|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.lib.ExtensionFunctionDefinition com.saxonica.functions.extfn.ForEachGroupFunction
public class ForEachGroupFunction
This class implements the extension function saxon:for-each-group(). This is a higher order function that provides grouping capability. Its effect is similar to the XSLT 2.0 for-each-group instruction, but it works also in XQuery. The first argument is the population to be grouped; the second argument is a function that calculates the grouping key; the third argument is the action to be performed on each group: it gets the members of the group as its argument.
Constructor Summary | |
---|---|
ForEachGroupFunction()
|
Method Summary | |
---|---|
SequenceType[] |
getArgumentTypes()
Get the required types for the arguments of this function, counting from zero |
StructuredQName |
getFunctionQName()
Get the function name, as a QName |
int |
getMaximumNumberOfArguments()
Get the maximum number of arguments allowed by the function |
int |
getMinimumNumberOfArguments()
Get the minimum number of arguments required by the function |
SequenceType |
getResultType(SequenceType[] suppliedArgumentTypes)
Get the type of the result of the function |
ExtensionFunctionCall |
makeCallExpression()
Create a call on this function. |
Methods inherited from class net.sf.saxon.lib.ExtensionFunctionDefinition |
---|
dependsOnFocus, hasSideEffects, trustResultType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ForEachGroupFunction()
Method Detail |
---|
public StructuredQName getFunctionQName()
getFunctionQName
in class ExtensionFunctionDefinition
public int getMinimumNumberOfArguments()
getMinimumNumberOfArguments
in class ExtensionFunctionDefinition
public int getMaximumNumberOfArguments()
getMaximumNumberOfArguments
in class ExtensionFunctionDefinition
public SequenceType[] getArgumentTypes()
getArgumentTypes
in class ExtensionFunctionDefinition
getMaximumNumberOfArguments()
; however for functions
that allow a variable number of arguments, the array can be smaller than this, with the last
entry in the array providing the required type for all the remaining arguments.public SequenceType getResultType(SequenceType[] suppliedArgumentTypes)
getResultType
in class ExtensionFunctionDefinition
suppliedArgumentTypes
- the static types of the arguments to the function.
This is provided so that a more precise result type can be returned in the common
case where the type of the result depends on the type of the first argument. The value
will be null if the function call has no arguments.
public ExtensionFunctionCall makeCallExpression()
makeCallExpression
in class ExtensionFunctionDefinition
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |