Class PartialApply

  • All Implemented Interfaces:
    ExportAgent, Locatable, IdentityComparable, Traceable

    public class PartialApply
    extends Expression
    This expression class implements the operation of currying (or performing partial application) of a function. That is, it takes a function and a set of argument bindings as input, and produces a new function as output.
    • Constructor Detail

      • PartialApply

        public PartialApply​(Expression base,
                            Expression[] boundArguments)
        Create a partial function application expression
        base - the expression that returns the function to be called
        boundArguments - an array in which each element is either an expression to be bound to the corresponding argument, or null to represent a placeholder ("?" in the source syntax)
    • Method Detail

      • getBaseExpression

        public Expression getBaseExpression()
      • setBaseExpression

        public void setBaseExpression​(Expression base)
      • getNumberOfPlaceHolders

        public int getNumberOfPlaceHolders()
      • typeCheck

        public Expression typeCheck​(ExpressionVisitor visitor,
                                    ContextItemStaticInfo contextInfo)
                             throws XPathException
        Description copied from class: Expression
        Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.

        This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

        This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.

        typeCheck in class Expression
        visitor - an expression visitor
        contextInfo - Information available statically about the context item: whether it is (possibly) absent; its static type; its streaming posture.
        the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
        XPathException - if an error is discovered during this phase (typically a type error)
      • getItemType

        public ItemType getItemType()
        Description copied from class: Expression
        Determine the static item type of the expression, as precisely possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

        This method should always return a result, though it may be the best approximation that is available at the time.

        Specified by:
        getItemType in class Expression
        a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)
      • 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.

        operands in class Expression
        an iterator containing the sub-expressions of this expression
      • getNumberOfArguments

        public int getNumberOfArguments()
      • getArgument

        public Expression getArgument​(int n)
      • getImplementationMethod

        public int getImplementationMethod()
        Description copied from class: Expression
        An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is provided directly. The other methods will always be available indirectly, using an implementation that relies on one of the other methods.
        Specified by:
        getImplementationMethod in class Expression
        the implementation method, for example Expression.ITERATE_METHOD or Expression.EVALUATE_METHOD or Expression.PROCESS_METHOD
      • equals

        public boolean equals​(java.lang.Object other)
        Is this expression the same as another expression?
        equals in class Expression
        other - the expression to be compared with this one
        true if the two expressions are statically equivalent
      • computeHashCode

        public int computeHashCode()
        Hashcode supporting equals()
        computeHashCode in class Expression
        a computed hash code
      • export

        public void export​(ExpressionPresenter out)
                    throws XPathException
        Description copied from class: Expression
        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
        out - the expression presenter used to display the structure
        XPathException - if the export fails, for example if an expression is found that won't work in the target environment.
      • copy

        public Expression copy​(RebindingMap rebindings)
        Description copied from class: Expression
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        rebindings - a mutable list of (old binding, new binding) pairs that is used to update the bindings held in any local variable references that are copied.
        the copy of the original expression
      • toString

        public java.lang.String toString()

        The toString() method for an expression attempts to give a representation of the expression in an XPath-like form.

        For subclasses of Expression that represent XPath expressions, the result should always be a string that parses as an XPath 3.0 expression. The expression produced should be equivalent to the original making certain assumptions about the static context. In general the expansion will make no assumptions about namespace bindings, except that (a) the prefix "xs" is used to refer to the XML Schema namespace, and (b) the default funcion namespace is assumed to be the "fn" namespace.

        In the case of XSLT instructions and XQuery expressions, the toString() method gives an abstracted view of the syntax that is not designed in general to be parseable.

        toString in class Expression
        a representation of the expression as a string
      • evaluateItem

        public Function evaluateItem​(XPathContext context)
                              throws XPathException
        Evaluate this expression at run-time
        evaluateItem in class Expression
        context - The XPath dynamic evaluation context
        the result of the function, or null to represent an empty sequence
        XPathException - if a dynamic error occurs during evaluation of the function.
      • getExpressionName

        public java.lang.String getExpressionName()
        Get a name identifying the kind of expression, in terms meaningful to a user.
        getExpressionName in class Expression
        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 export() output displaying the expression.