Package net.sf.saxon.style

Class XSLFunction

java.lang.Object
net.sf.saxon.tree.NodeImpl
net.sf.saxon.tree.ParentNodeImpl
net.sf.saxon.tree.ElementImpl
net.sf.saxon.tree.ElementWithAttributes
net.sf.saxon.style.StyleElement
net.sf.saxon.style.XSLFunction
All Implemented Interfaces:
Source, SourceLocator, LocationProvider, SaxonLocator, Container, FingerprintedNode, Item, NodeInfo, ValueRepresentation, StylesheetProcedure, InstructionInfo, Locator
public class XSLFunction extends StyleElement implements StylesheetProcedure
Handler for xsl:function elements in stylesheet (XSLT 2.0).
Attributes:
name gives the name of the function saxon:memo-function=yes|no indicates whether it acts as a memo function.

  • Field Details

    • references

      List references

  • Constructor Details

    • XSLFunction

      public XSLFunction()

  • Method Details

    • registerReference

      public void registerReference(UserFunctionCall ref)
      Method called by UserFunctionCall to register the function call for subsequent fixup.
      Parameters:
      ref - the UserFunctionCall to be registered

    • prepareAttributes

      public void prepareAttributes() throws XPathException
      Description copied from class: StyleElement
      Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass
      Specified by:
      prepareAttributes in class StyleElement
      Throws:
      XPathException

    • mayContainSequenceConstructor

      public boolean mayContainSequenceConstructor()
      Determine whether this type of element is allowed to contain a template-body.
      Overrides:
      mayContainSequenceConstructor in class StyleElement
      Returns:
      true: yes, it may contain a general template-body

    • isPermittedChild

      protected boolean isPermittedChild(StyleElement child)
      Specify that xsl:param is a permitted child
      Overrides:
      isPermittedChild in class StyleElement

    • isOverriding

      public boolean isOverriding()
      Is override="yes"?.
      Returns:
      true if override="yes" was specified, otherwise false

    • fixupReferences

      public void fixupReferences() throws XPathException
      Notify all references to this function of the data type.
      Overrides:
      fixupReferences in class StyleElement
      Throws:
      XPathException

    • validate

      public void validate() throws XPathException
      Description copied from class: StyleElement
      Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.
      Overrides:
      validate in class StyleElement
      Throws:
      XPathException

    • compile

      public Expression compile(Executable exec) throws XPathException
      Compile the function definition to create an executable representation
      Specified by:
      compile in class StyleElement
      Returns:
      an Instruction, or null. The instruction returned is actually rather irrelevant; the compile() method has the side-effect of binding all references to the function to the executable representation (a UserFunction object)
      Throws:
      XPathException

    • getSlotManager

      public SlotManager getSlotManager()
      Get associated Procedure (for details of stack frame).
      Specified by:
      getSlotManager in interface StylesheetProcedure
      Returns:
      the associated Procedure object

    • getFunctionFingerprint

      public int getFunctionFingerprint()
      Get the fingerprint of the name of this function.
      Returns:
      the fingerprint of the name

    • getResultType

      public SequenceType getResultType()
      Get the type of value returned by this function
      Returns:
      the declared result type, or the inferred result type if this is more precise

    • getNumberOfArguments

      public int getNumberOfArguments()
      Get the number of arguments declared by this function (that is, its arity).
      Returns:
      the arity of the function

    • setParameterDefinitions

      public void setParameterDefinitions(UserFunction fn)
      Set the definitions of the parameters in the compiled function, as an array.

    • getCompiledFunction

      public UserFunction getCompiledFunction()
      Get the compiled function

    • getConstructType

      public int getConstructType()
      Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface
      Specified by:
      getConstructType in interface InstructionInfo
      Overrides:
      getConstructType in class StyleElement