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, FunctionItem, 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 Details

    • BoundUserFunction

      public BoundUserFunction(FunctionItem function, int arity, Component component, ExportAgent agent, Controller controller)
      Create a bound user function
      Parameters:
      function - the function in question
      arity - the specific arity. This is relevant when the function item has an arity range and we are binding a function reference to a specific arity version
      component - the XSLT component containing the function (the same function in two different packages corresponds to different components)
      agent - used when the function needs to be exported to a SEF file
      controller - the controller object

  • Method Details

    • getTargetFunction

      public FunctionItem getTargetFunction()

    • getController

      public Controller getController()

    • makeNewContext

      public XPathContext makeNewContext(XPathContext oldContext, ContextOriginator originator)
      Description copied from class: AbstractFunction
      Prepare an XPathContext object for evaluating the function
      Specified by:
      makeNewContext in interface FunctionItem
      Overrides:
      makeNewContext in class AbstractFunction
      Parameters:
      oldContext - the XPathContext of the function calling expression
      originator - the originator of the new context
      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: Callable
      Call the Callable.
      Specified by:
      call in interface Callable
      Parameters:
      context - the dynamic evaluation context
      args - the values of the arguments, supplied as Sequences.

      Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

      If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

      It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

      Returns:
      the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.
      Throws:
      XPathException - if a dynamic error occurs during the evaluation of the expression

    • getFunctionItemType

      public FunctionItemType getFunctionItemType()
      Description copied from interface: FunctionItem
      Get the item type of the function item
      Specified by:
      getFunctionItemType in interface FunctionItem
      Returns:
      the function item's type

    • getAnnotations

      public AnnotationList getAnnotations()
      Description copied from interface: FunctionItem
      Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.
      Specified by:
      getAnnotations in interface FunctionItem
      Overrides:
      getAnnotations in class AbstractFunction
      Returns:
      the function annotations

    • getFunctionName

      public StructuredQName getFunctionName()
      Description copied from interface: FunctionItem
      Get the name of the function, or null if it is anonymous
      Specified by:
      getFunctionName in interface FunctionItem
      Returns:
      the function name, or null for an anonymous inline function

    • getArity

      public int getArity()
      Description copied from interface: FunctionItem
      Get the arity of the function
      Specified by:
      getArity in interface FunctionItem
      Returns:
      the number of arguments in the function signature

    • getDescription

      public String getDescription()
      Description copied from interface: FunctionItem
      Get 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:
      getDescription in interface FunctionItem
      Returns:
      a description of the function for use in error messages

    • export

      public void export(ExpressionPresenter out) throws XPathException
      Description copied from class: AbstractFunction
      Output information about this function item to the diagnostic explain() output
      Specified by:
      export in interface FunctionItem
      Overrides:
      export in class AbstractFunction
      Parameters:
      out - the destination for the information
      Throws:
      XPathException - if things go wrong