Class Location

java.lang.Object
net.sf.saxon.trace.Location

public class Location extends Object
This class holds constants identifying different kinds of location in a source stylesheet or query. These constants are used in the getConstructType() method of class InstructionInfo. Some of these locations represent points where the dynamic context changes, and they are therefore recorded as such on the context stack. Some of the locations represent points in the evaluation of a stylesheet (or query or XPath expression) that are notified to the trace listener. Some fulfil both roles.

Any constant used in StandardNames can be used as a Location. Such names are generally used to identify XSLT instructions. They are also used for equivalent constructs in XQuery, for example XSL_ELEMENT is used for a computed element constructor in XQuery. The constants in StandardNames are all in the range 0-1023, so constants defined in this class are outside this range.

The constants in this file are annotated with Q to indicate they can appear in XQuery trace output, T to indicate they can appear in XSLT trace output, and/or C to indicate that they can appear on the dynamic context stack.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    An XSLT built-in template rule.
    static final int
    CASE clause within "typeswitch".
    static final int
    Values of the form CLAUSE_BASE + n represent FLWOR clauses
    static final int
    The outer system environment, identified as the caller of a user query or stylesheet.
    static final int
    An XQuery Update copy-modify (transform) expression.
    static final int
    DEFAULT clause within "typeswitch".
    static final int
    An XPath or XQuery delete expression.
    static final int
    An XPath or XQuery "else" clause.
    static final int
    An XSLT instruction.
    static final int
    An XPath or XQuery "for" clause.
    static final int
    A function declaration in XSLT or XQuery
    static final int
    An XPath function call to a user-defined function.
    static final int
    An XPath or XQuery "if" expression.
    static final int
    An XQuery Update insert expression.
    static final int
    Lazy evaluation of an expression (this code is used to identify a context created as a saved copy of an existing context, to be stored in a Closure).
    static final int
    An XQuery "let" clause, or an XSLT local variable (which compiles into a LET clause).
    static final int
    An attribute of an XSLT literal result element or of an XQuery direct element constructor.
    static final int
    An XSLT literal result element, or an XQuery direct element constructor.
    static final int
    An order-by clause in a FLWOR expression.
    static final int
    An XPath or XQuery path expression.
    static final int
    An XPath or XQuery rename expression.
    static final int
    An XPath or XQuery replace expression.
    static final int
    An XPath or XQuery "return" clause.
    static final int
    An XPath expression constructed dynamically using saxon:evaluate (or saxon:expression).
    static final int
    An XPath or XQuery "switch" expression.
    static final int
    An XSLT user-written template rule or named template.
    static final int
    An XPath or XQuery "then" clause.
    static final int
    An explicit call of the fn:trace() function.
    static final int
    An XPath or XQuery "typeswitch" expression.
    static final int
    Unclassified location.
    static final int
    An XPath or XQuery "validate" expression.
    static final int
    A WHERE clause in a FLWOR expression.
    static final int
    XPath expression, otherwise unclassified.
    static final int
    Entry point to a top-level XPath expression within an XSLT stylesheet.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • CONTROLLER

      public static final int CONTROLLER
      The outer system environment, identified as the caller of a user query or stylesheet. Usage:C
      See Also:
    • EXTENSION_INSTRUCTION

      public static final int EXTENSION_INSTRUCTION
      An XSLT instruction. The name of the instruction (which may be an extension instruction) can be obtained using the fingerprint property. Usage:T
      See Also:
    • LITERAL_RESULT_ELEMENT

      public static final int LITERAL_RESULT_ELEMENT
      An XSLT literal result element, or an XQuery direct element constructor. Usage:QT
      See Also:
    • LITERAL_RESULT_ATTRIBUTE

      public static final int LITERAL_RESULT_ATTRIBUTE
      An attribute of an XSLT literal result element or of an XQuery direct element constructor. Usage: QT
      See Also:
    • TEMPLATE

      public static final int TEMPLATE
      An XSLT user-written template rule or named template. Usage: TC
      See Also:
    • FUNCTION_CALL

      public static final int FUNCTION_CALL
      An XPath function call to a user-defined function. The "expression" property references the actual expression, of class ComputedExpression. The "target" property references the function being called, of class UserFunction. Usage: QTC
      See Also:
    • BUILT_IN_TEMPLATE

      public static final int BUILT_IN_TEMPLATE
      An XSLT built-in template rule. Usage: TC
      See Also:
    • XPATH_IN_XSLT

      public static final int XPATH_IN_XSLT
      Entry point to a top-level XPath expression within an XSLT stylesheet. Usage: TC
      See Also:
    • FOR_EXPRESSION

      public static final int FOR_EXPRESSION
      An XPath or XQuery "for" clause. Usage: Q
      See Also:
    • LET_EXPRESSION

      public static final int LET_EXPRESSION
      An XQuery "let" clause, or an XSLT local variable (which compiles into a LET clause). Usage: Q,T
      See Also:
    • RETURN_EXPRESSION

      public static final int RETURN_EXPRESSION
      An XPath or XQuery "return" clause. Usage: Q
      See Also:
    • IF_EXPRESSION

      public static final int IF_EXPRESSION
      An XPath or XQuery "if" expression. Usage: Q
      See Also:
    • THEN_EXPRESSION

      public static final int THEN_EXPRESSION
      An XPath or XQuery "then" clause. Usage: Q
      See Also:
    • ELSE_EXPRESSION

      public static final int ELSE_EXPRESSION
      An XPath or XQuery "else" clause. Usage: Q
      See Also:
    • WHERE_CLAUSE

      public static final int WHERE_CLAUSE
      A WHERE clause in a FLWOR expression. Usage: Q
      See Also:
    • ORDER_BY_CLAUSE

      public static final int ORDER_BY_CLAUSE
      An order-by clause in a FLWOR expression. Usage: Q
      See Also:
    • TYPESWITCH_EXPRESSION

      public static final int TYPESWITCH_EXPRESSION
      An XPath or XQuery "typeswitch" expression. Usage: Q
      See Also:
    • CASE_EXPRESSION

      public static final int CASE_EXPRESSION
      CASE clause within "typeswitch". Usage: Q
      See Also:
    • DEFAULT_EXPRESSION

      public static final int DEFAULT_EXPRESSION
      DEFAULT clause within "typeswitch". Usage: Q
      See Also:
    • VALIDATE_EXPRESSION

      public static final int VALIDATE_EXPRESSION
      An XPath or XQuery "validate" expression. Usage: Q
      See Also:
    • PATH_EXPRESSION

      public static final int PATH_EXPRESSION
      An XPath or XQuery path expression. Usage: C
      See Also:
    • SWITCH_EXPRESSION

      public static final int SWITCH_EXPRESSION
      An XPath or XQuery "switch" expression. Usage: Q
      See Also:
    • COPY_MODIFY_EXPRESSION

      public static final int COPY_MODIFY_EXPRESSION
      An XQuery Update copy-modify (transform) expression. Usage: Q
      See Also:
    • INSERT_EXPRESSION

      public static final int INSERT_EXPRESSION
      An XQuery Update insert expression. Usage: Q
      See Also:
    • REPLACE_EXPRESSION

      public static final int REPLACE_EXPRESSION
      An XPath or XQuery replace expression. Usage: Q
      See Also:
    • DELETE_EXPRESSION

      public static final int DELETE_EXPRESSION
      An XPath or XQuery delete expression. Usage: Q
      See Also:
    • RENAME_EXPRESSION

      public static final int RENAME_EXPRESSION
      An XPath or XQuery rename expression. Usage: Q
      See Also:
    • TRACE_CALL

      public static final int TRACE_CALL
      An explicit call of the fn:trace() function. Usage: QT
      See Also:
    • SAXON_EVALUATE

      public static final int SAXON_EVALUATE
      An XPath expression constructed dynamically using saxon:evaluate (or saxon:expression). Usage: QTC
      See Also:
    • LAZY_EVALUATION

      public static final int LAZY_EVALUATION
      Lazy evaluation of an expression (this code is used to identify a context created as a saved copy of an existing context, to be stored in a Closure). Usage: C
      See Also:
    • FUNCTION

      public static final int FUNCTION
      A function declaration in XSLT or XQuery
      See Also:
    • XPATH_EXPRESSION

      public static final int XPATH_EXPRESSION
      XPath expression, otherwise unclassified. The "expression" property references the actual expression, of class ComputedExpression. Used in fallback cases only.
      See Also:
    • UNCLASSIFIED

      public static final int UNCLASSIFIED
      Unclassified location. Used in fallback cases only.
      See Also:
    • CLAUSE_BASE

      public static final int CLAUSE_BASE
      Values of the form CLAUSE_BASE + n represent FLWOR clauses
      See Also: