Package net.sf.saxon.functions.hof
Class UserFunctionReference.BoundUserFunction
- java.lang.Object
-
- net.sf.saxon.functions.AbstractFunction
-
- net.sf.saxon.functions.hof.UserFunctionReference.BoundUserFunction
-
- All Implemented Interfaces:
Callable,ContextOriginator,Function,GroundedValue,Item,Sequence
- Enclosing class:
- UserFunctionReference
public static class UserFunctionReference.BoundUserFunction extends AbstractFunction implements ContextOriginator
A BoundUserFunction represents a user-defined function seen as a component. A single source-level XSLT function may be the actor in several different components (in different stylesheet packages). Although the code of the function is identical in each case, the bindings to other stylesheet components may be different.
-
-
Constructor Summary
Constructors Constructor Description BoundUserFunction(ExportAgent agent, Function function, Component component, Controller controller)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Sequencecall(XPathContext context, Sequence[] args)Invoke the functionvoidexport(ExpressionPresenter out)Output information about this function item to the diagnostic explain() outputAnnotationListgetAnnotations()Get the function annotations (as defined in XQuery).intgetArity()Get the arity of the functionControllergetController()java.lang.StringgetDescription()Get a description of this function for use in error messages.FunctionItemTypegetFunctionItemType()Get the item type of the function itemStructuredQNamegetFunctionName()Get the name of the function, or null if it is anonymousFunctiongetTargetFunction()XPathContextmakeNewContext(XPathContext oldContext, ContextOriginator originator)Prepare an XPathContext object for evaluating the function-
Methods inherited from class net.sf.saxon.functions.AbstractFunction
atomize, deepEquals, effectiveBooleanValue, getOperandRoles, getStringValue, getStringValueCS, isArray, isMap, isTrustedResultType, simplify, typeCheck
-
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.Function
getGenre, toShortString
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, isStreamed, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Constructor Detail
-
BoundUserFunction
public BoundUserFunction(ExportAgent agent, Function function, Component component, Controller controller)
-
-
Method Detail
-
getTargetFunction
public Function getTargetFunction()
-
getController
public Controller getController()
-
makeNewContext
public XPathContext makeNewContext(XPathContext oldContext, ContextOriginator originator)
Description copied from class:AbstractFunctionPrepare an XPathContext object for evaluating the function- Specified by:
makeNewContextin interfaceFunction- Overrides:
makeNewContextin classAbstractFunction- Parameters:
oldContext- the XPathContext of the function calling expressionoriginator- identifies the location of the caller for diagnostics- Returns:
- a suitable context for evaluating the function (which may or may not be the same as the caller's context)
-
call
public Sequence call(XPathContext context, Sequence[] args) throws XPathException
Description copied from interface:FunctionInvoke the function- Specified by:
callin interfaceCallable- Specified by:
callin interfaceFunction- Parameters:
context- the XPath dynamic evaluation contextargs- the actual arguments to be supplied- Returns:
- the result of invoking the function
- Throws:
XPathException- if a dynamic error occurs within the function
-
getFunctionItemType
public FunctionItemType getFunctionItemType()
Description copied from interface:FunctionGet the item type of the function item- Specified by:
getFunctionItemTypein interfaceFunction- Returns:
- the function item's type
-
getAnnotations
public AnnotationList getAnnotations()
Description copied from interface:FunctionGet the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.- Specified by:
getAnnotationsin interfaceFunction- Overrides:
getAnnotationsin classAbstractFunction- Returns:
- the function annotations
-
getFunctionName
public StructuredQName getFunctionName()
Description copied from interface:FunctionGet the name of the function, or null if it is anonymous- Specified by:
getFunctionNamein interfaceFunction- Returns:
- the function name, or null for an anonymous inline function
-
getArity
public int getArity()
Description copied from interface:FunctionGet the arity of the function
-
getDescription
public java.lang.String getDescription()
Description copied from interface:FunctionGet a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".- Specified by:
getDescriptionin interfaceFunction- Returns:
- a description of the function for use in error messages
-
export
public void export(ExpressionPresenter out) throws XPathException
Description copied from class:AbstractFunctionOutput information about this function item to the diagnostic explain() output- Specified by:
exportin interfaceFunction- Overrides:
exportin classAbstractFunction- Throws:
XPathException
-
-