Package net.sf.saxon.expr.flwor

Class DiagnosticClause

java.lang.Object
net.sf.saxon.expr.flwor.Clause
net.sf.saxon.expr.flwor.DiagnosticClause
public class DiagnosticClause extends Clause
A "let" clause in a FLWOR expression

  • Constructor Details

    • DiagnosticClause

      public DiagnosticClause()

  • Method Details

    • getClauseKey

      public Clause.ClauseName getClauseKey()
      Description copied from class: Clause
      Get a keyword identifying what kind of clause this is
      Specified by:
      getClauseKey in class Clause
      Returns:
      the kind of clause

    • getEvaluator

      public PullEvaluator getEvaluator()

    • copy

      public DiagnosticClause copy(FLWORExpression flwor, RebindingMap rebindings)
      Description copied from class: Clause
      Create a copy of this clause
      Specified by:
      copy in class Clause
      Parameters:
      flwor - the new FLWORExpression to contain the copied clause. Note that this will not have been fully initialized.
      rebindings - the rebinding map
      Returns:
      the copied clause

    • initSequence

      public void initSequence(FLWORExpression flwor, Expression sequence)

    • getSequence

      public Expression getSequence()

    • getRangeVariables

      public LocalVariableBinding[] getRangeVariables()
      Get the number of variables bound by this clause
      Overrides:
      getRangeVariables in class Clause
      Returns:
      the number of variable bindings

    • getPullStream

      public TuplePull getPullStream(TuplePull base, XPathContext context)
      Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies
      Specified by:
      getPullStream in class Clause
      Parameters:
      base - the input tuple stream
      context - the XPath context
      Returns:
      the output tuple stream

    • getPushStream

      public TuplePush getPushStream(TuplePush destination, Outputter output, XPathContext context)
      Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream
      Specified by:
      getPushStream in class Clause
      Parameters:
      destination - the output tuple stream
      output - the destination for the result
      context - the XPath context
      Returns:
      the push tuple stream that implements the functionality of this clause of the FLWOR expression

    • processOperands

      public void processOperands(OperandProcessor processor) throws XPathException
      Process the subexpressions of this clause
      Specified by:
      processOperands in class Clause
      Parameters:
      processor - the expression processor used to process the subexpressions
      Throws:
      XPathException - if any error is detected

    • typeCheck

      public void typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) throws XPathException
      Type-check the expression
      Overrides:
      typeCheck in class Clause
      Parameters:
      visitor - the ExpressionVisitor, providing access to static context information
      contextInfo - static information about the dynamic context
      Throws:
      XPathException - if any error is detected

    • gatherVariableReferences

      public void gatherVariableReferences(ExpressionVisitor visitor, Binding binding, List<VariableReference> references)
      Description copied from class: Clause
      Build a list of all references to a variables declared in this clause
      Overrides:
      gatherVariableReferences in class Clause
      Parameters:
      visitor - the expression visitor
      binding - a variable declared in this clause
      references - the list of variable references, initially empty, to which the method will append

    • refineVariableType

      public void refineVariableType(ExpressionVisitor visitor, List<VariableReference> references, Expression returnExpr)
      Description copied from class: Clause
      Supply improved type information to the expressions that contain references to the variables declared in this clause
      Overrides:
      refineVariableType in class Clause
      Parameters:
      visitor - the expression visitor
      references - the list of variable references
      returnExpr - the expression in the return clause

    • addToPathMap

      public void addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
      Description copied from class: Clause
      Collect information about the navigation paths followed by this clause, for document projection purposes
      Specified by:
      addToPathMap in class Clause
      Parameters:
      pathMap - the path map in which the data is to be collected
      pathMapNodeSet - the path map node set representing the paths to the context item

    • explain

      public void explain(ExpressionPresenter out) throws XPathException
      Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
      Specified by:
      explain in class Clause
      Parameters:
      out - the expression presenter used to display the structure
      Throws:
      XPathException - if any error occurs

    • toShortString

      public String toShortString()
      Description copied from class: Clause
      Get a short string representation of the clause
      Overrides:
      toShortString in class Clause
      Returns:
      a recognizable string

    • toString

      public String toString()
      Overrides:
      toString in class Object