Class FuncExtFunction

  • All Implemented Interfaces:
    java.io.Serializable, javax.xml.transform.SourceLocator, ExpressionNode, XPathVisitable

    public class FuncExtFunction
    extends Function
    An object of this class represents an extension call expression. When the expression executes, it calls ExtensionsTable#extFunction, and then converts the result to the appropriate XObject.
    See Also:
    Serialized Form
    • Constructor Detail

      • FuncExtFunction

        public FuncExtFunction​(java.lang.String namespace,
                               java.lang.String extensionName,
                               java.lang.Object methodKey)
        Create a new FuncExtFunction based on the qualified name of the extension, and a unique method key.
        Parameters:
        namespace - The namespace for the extension function, which should not normally be null or empty.
        extensionName - The local name of the extension.
        methodKey - Unique method key, which is passed to ExtensionsTable#extFunction in order to allow caching of the method.
    • Method Detail

      • fixupVariables

        public void fixupVariables​(java.util.Vector vars,
                                   int globalsSize)
        This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
        Specified by:
        fixupVariables in class Expression
        Parameters:
        vars - List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame). NEEDSDOC @param globalsSize
      • getNamespace

        public java.lang.String getNamespace()
        Return the namespace of the extension function.
        Returns:
        The namespace of the extension function.
      • getFunctionName

        public java.lang.String getFunctionName()
        Return the name of the extension function.
        Returns:
        The name of the extension function.
      • getMethodKey

        public java.lang.Object getMethodKey()
        Return the method key of the extension function.
        Returns:
        The method key of the extension function.
      • getArg

        public Expression getArg​(int n)
        Return the nth argument passed to the extension function.
        Parameters:
        n - The argument number index.
        Returns:
        The Expression object at the given index.
      • getArgCount

        public int getArgCount()
        Return the number of arguments that were passed into this extension function.
        Returns:
        The number of arguments.
      • execute

        public XObject execute​(XPathContext xctxt)
                        throws javax.xml.transform.TransformerException
        Execute the function. The function must return a valid object.
        Overrides:
        execute in class Function
        Parameters:
        xctxt - The current execution context.
        Returns:
        A valid XObject.
        Throws:
        javax.xml.transform.TransformerException
      • setArg

        public void setArg​(Expression arg,
                           int argNum)
                    throws WrongNumberArgsException
        Set an argument expression for a function. This method is called by the XPath compiler.
        Overrides:
        setArg in class Function
        Parameters:
        arg - non-null expression that represents the argument.
        argNum - The argument number index.
        Throws:
        WrongNumberArgsException - If the argNum parameter is beyond what is specified for this function.
      • toString

        public java.lang.String toString()
        Return the name of the extesion function in string format
        Overrides:
        toString in class java.lang.Object