Class LocalParamBlock

    • Constructor Detail

      • LocalParamBlock

        public LocalParamBlock​(LocalParam[] params)
        Create the block of parameters
        Parameters:
        params - the parameters
    • Method Detail

      • getExpressionName

        public java.lang.String getExpressionName()
        Description copied from class: Instruction
        Get a name identifying the kind of expression, in terms meaningful to a user.
        Overrides:
        getExpressionName in class Instruction
        Returns:
        a name identifying the kind of expression, in terms meaningful to a user. The name will always be in the form of a lexical XML QName, and should match the name used in explain() output displaying the expression.
      • operands

        public java.lang.Iterable<Operand> operands()
        Description copied from class: Expression
        Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression. Default implementation works off the results of iterateSubExpressions()

        If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

        Specified by:
        operands in class Instruction
        Returns:
        an iterator containing the sub-expressions of this expression
      • getNumberOfParams

        public int getNumberOfParams()
      • computeSpecialProperties

        protected int computeSpecialProperties()
        Description copied from class: Instruction
        Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.
        Overrides:
        computeSpecialProperties in class Instruction
        Returns:
        a set of flags indicating static properties of this expression
      • copy

        public Expression copy​(RebindingMap rebindings)
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        Parameters:
        rebindings - the rebinding map
        Returns:
        the copy of the original expression
      • getItemType

        public final ItemType getItemType()
        Determine the data type of the items returned by this expression
        Overrides:
        getItemType in class Instruction
        Returns:
        the data type
      • getCardinality

        public final int getCardinality()
        Determine the cardinality of the expression
        Overrides:
        getCardinality in class Expression
        Returns:
        one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).
      • export

        public void export​(ExpressionPresenter out)
                    throws XPathException
        Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
        Specified by:
        export in interface ExportAgent
        Specified by:
        export in class Expression
        Parameters:
        out - the expression presenter used to display the structure
        Throws:
        XPathException - if the export fails, for example if an expression is found that won't work in the target environment.
      • processLeavingTail

        public TailCall processLeavingTail​(Outputter output,
                                           XPathContext context)
                                    throws XPathException
        Description copied from class: Instruction
        ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.
        Specified by:
        processLeavingTail in interface TailCallReturner
        Specified by:
        processLeavingTail in class Instruction
        Parameters:
        output - the destination for the result
        context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.
        Returns:
        null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
        Throws:
        XPathException - if a dynamic error occurs during the evaluation of the instruction