Package net.sf.saxon.expr

Class EarlyEvaluationContext

java.lang.Object
net.sf.saxon.expr.EarlyEvaluationContext
All Implemented Interfaces:
XPathContext
public class EarlyEvaluationContext extends Object implements XPathContext
This class is an implementation of XPathContext used when evaluating constant sub-expressions at compile time.

  • Constructor Details

    • EarlyEvaluationContext

      public EarlyEvaluationContext(Configuration config)
      Create an early evaluation context, used for evaluating constant expressions at compile time
      Parameters:
      config - the Saxon configuration //@param map the available collations

  • Method Details

    • evaluateLocalVariable

      public Sequence evaluateLocalVariable(int slotnumber)
      Get the value of a local variable, identified by its slot number
      Specified by:
      evaluateLocalVariable in interface XPathContext
      Parameters:
      slotnumber - the slot number allocated at compile time to the variable, which identifies its position within the local stack frame
      Returns:
      the value of the variable.

    • getCaller

      public XPathContext getCaller()
      Get the calling XPathContext (the next one down the stack). This will be null if unknown, or if the bottom of the stack has been reached.
      Specified by:
      getCaller in interface XPathContext
      Returns:
      the XPathContext of the calling expression

    • getMajorContext

      public XPathContextMajor getMajorContext()
      Get the nearest XPathContextMajor (the next one down the stack). This will be null if unknown, or if the bottom of the stack has been reached.
      Specified by:
      getMajorContext in interface XPathContext
      Returns:
      the nearest XPathContextMajor

    • getResourceResolver

      public ResourceResolver getResourceResolver()
      Get the URI resolver. This gets the local URIResolver set in the XPathContext if there is one; if not, it gets the URIResolver from the Controller (which itself defaults to the one set in the Configuration).
      Specified by:
      getResourceResolver in interface XPathContext
      Returns:
      the user-supplied URI resolver if there is one, or null otherwise.
      Since:
      9.6

    • getErrorReporter

      public ErrorReporter getErrorReporter()
      Get the error listener. If no ErrorListener has been set locally, the ErrorListener in the Controller is returned; this in turn defaults to the ErrorListener set in the Configuration.
      Specified by:
      getErrorReporter in interface XPathContext
      Returns:
      the ErrorListener in use. This will always be an UnfailingErrorListener, which is a Saxon subclass of ErrorListener that throws no exceptions.
      Since:
      9.6

    • getCurrentComponent

      public Component getCurrentComponent()
      Get the current component
      Specified by:
      getCurrentComponent in interface XPathContext
      Returns:
      the current component

    • getConfiguration

      public Configuration getConfiguration()
      Get the Configuration
      Specified by:
      getConfiguration in interface XPathContext
      Returns:
      the Saxon configuration object

    • getContextItem

      public Item getContextItem()
      Get the context item
      Specified by:
      getContextItem in interface XPathContext
      Returns:
      the context item, or null if the context item is undefined

    • getController

      public Controller getController()
      Get the Controller. May return null when running outside XSLT or XQuery
      Specified by:
      getController in interface XPathContext
      Returns:
      the controller for this query or transformation

    • getCurrentGroupIterator

      public GroupIterator getCurrentGroupIterator()
      Get the current group iterator. This supports the current-group() and current-grouping-key() functions in XSLT 2.0
      Specified by:
      getCurrentGroupIterator in interface XPathContext
      Returns:
      the current grouped collection

    • getCurrentMergeGroupIterator

      public GroupIterator getCurrentMergeGroupIterator()
      Get the current merge group iterator. This supports the current-merge-group() and current-merge-key() functions in XSLT 3.0
      Specified by:
      getCurrentMergeGroupIterator in interface XPathContext
      Returns:
      the current grouped collection

    • getCurrentIterator

      public FocusTrackingIterator getCurrentIterator()
      Get the current iterator. This encapsulates the context item, context position, and context size.
      Specified by:
      getCurrentIterator in interface XPathContext
      Returns:
      the current iterator, or null if there is no current iterator (which means the context item, position, and size are undefined).

    • getCurrentMode

      public Component.M getCurrentMode()
      Get the current mode.
      Specified by:
      getCurrentMode in interface XPathContext
      Returns:
      the current mode

    • getCurrentRegexIterator

      public RegexIterator getCurrentRegexIterator()
      Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.
      Specified by:
      getCurrentRegexIterator in interface XPathContext
      Returns:
      the current regular expressions iterator

    • getCurrentTemplateRule

      public Rule getCurrentTemplateRule()
      Get the current template. This is used to support xsl:apply-imports
      Specified by:
      getCurrentTemplateRule in interface XPathContext
      Returns:
      the current template

    • getLast

      public int getLast() throws UncheckedXPathException
      Get the context size (the position of the last item in the current node list)
      Specified by:
      getLast in interface XPathContext
      Returns:
      the context size
      Throws:
      UncheckedXPathException - if the context position is undefined

    • getLocalParameters

      public ParameterSet getLocalParameters()
      Get the local (non-tunnel) parameters that were passed to the current function or template
      Specified by:
      getLocalParameters in interface XPathContext
      Returns:
      a ParameterSet containing the local parameters

    • getNamePool

      public NamePool getNamePool()
      Get the Name Pool
      Specified by:
      getNamePool in interface XPathContext
      Returns:
      the name pool

    • getStackFrame

      public StackFrame getStackFrame()
      Get a reference to the local stack frame for variables. Note that it's the caller's job to make a local copy of this. This is used for creating a Closure containing a retained copy of the variables for delayed evaluation.
      Specified by:
      getStackFrame in interface XPathContext
      Returns:
      array of variables.

    • getTunnelParameters

      public ParameterSet getTunnelParameters()
      Get the tunnel parameters that were passed to the current function or template. This includes all active tunnel parameters whether the current template uses them or not.
      Specified by:
      getTunnelParameters in interface XPathContext
      Returns:
      a ParameterSet containing the tunnel parameters

    • isAtLast

      public boolean isAtLast() throws XPathException
      Determine whether the context position is the same as the context size that is, whether position()=last()
      Specified by:
      isAtLast in interface XPathContext
      Returns:
      true if the context position is the same as the context size.
      Throws:
      XPathException - if a dynamic error occurs while determining the result

    • newCleanContext

      public XPathContextMajor newCleanContext()
      Construct a new context without copying (used for the context in a function call)
      Specified by:
      newCleanContext in interface XPathContext
      Returns:
      a new clean context

    • newContext

      public XPathContextMajor newContext()
      Construct a new context as a copy of another. The new context is effectively added to the top of a stack, and contains a pointer to the previous context
      Specified by:
      newContext in interface XPathContext
      Returns:
      a new context, created as a copy of this context

    • newMinorContext

      public XPathContextMinor newMinorContext()
      Construct a new minor context. A minor context can only hold new values of the focus (currentIterator) and current output destination.
      Specified by:
      newMinorContext in interface XPathContext
      Returns:
      a new minor context

    • setCaller

      public void setCaller(XPathContext caller)
      Set the calling XPathContext
      Specified by:
      setCaller in interface XPathContext
      Parameters:
      caller - the XPathContext of the calling expression

    • setCurrentIterator

      public void setCurrentIterator(FocusIterator iter)
      Set a new sequence iterator.
      Specified by:
      setCurrentIterator in interface XPathContext
      Parameters:
      iter - the current iterator. The context item, position, and size are determined by reference to the current iterator.

    • trackFocus

      public FocusIterator trackFocus(SequenceIterator iter)
      Description copied from interface: XPathContext
      Create, set, and return a focus tracking iterator that wraps a supplied sequence iterator.
      Specified by:
      trackFocus in interface XPathContext
      Parameters:
      iter - the current iterator. The context item, position, and size are determined by reference to the current iterator.
      Returns:
      the required focus tracking iterator

    • setLocalVariable

      public void setLocalVariable(int slotNumber, Sequence value)
      Set the value of a local variable, identified by its slot number
      Specified by:
      setLocalVariable in interface XPathContext
      Parameters:
      slotNumber - the slot number allocated at compile time to the variable, which identifies its position within the local stack frame
      value - the value of the variable

    • useLocalParameter

      public int useLocalParameter(StructuredQName parameterId, int slotNumber, boolean isTunnel)
      Use local parameter. This is called when a local xsl:param element is processed. If a parameter of the relevant name was supplied, it is bound to the xsl:param element. Otherwise the method returns false, so the xsl:param default will be evaluated
      Specified by:
      useLocalParameter in interface XPathContext
      Parameters:
      parameterId - Globally-unique parameter identifier
      slotNumber - Slot number of the parameter within the stack frame of the called template
      isTunnel - True if a tunnel parameter is required, else false @return true if a parameter of this name was supplied, false if not
      Returns:
      ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED

    • getCurrentDateTime

      public DateTimeValue getCurrentDateTime() throws NoDynamicContextException
      Get the current date and time. This implementation always throws a NoDynamicContextException.
      Specified by:
      getCurrentDateTime in interface XPathContext
      Returns:
      the current date and time. All calls within a single query or transformation will return the same value
      Throws:
      NoDynamicContextException - if this context object is one used only for early evaluation of constant expressions; the current date and time are not available in this case

    • getImplicitTimezone

      public int getImplicitTimezone()
      Get the implicit timezone, as a positive or negative offset from UTC in minutes. The range is -14hours to +14hours. This implementation returns CalendarValue.MISSING_TIMEZONE, meaning the value is unknown.
      Specified by:
      getImplicitTimezone in interface XPathContext
      Returns:
      the implicit timezone, as an offset from UTC in minutes

    • iterateStackFrames

      public Iterator<ContextStackFrame> iterateStackFrames()
      Get the context stack. This method returns an iterator whose items are instances of ContextStackFrame, starting with the top-most stackframe and ending at the point the query or transformation was invoked by a calling application.
      Specified by:
      iterateStackFrames in interface XPathContext
      Returns:
      an iterator over a copy of the run-time call stack

    • getCurrentException

      public XPathException getCurrentException()
      Get the current exception (in saxon:catch)
      Specified by:
      getCurrentException in interface XPathContext
      Returns:
      the current exception, or null if there is none defined

    • waitForChildThreads

      public void waitForChildThreads() throws XPathException
      Description copied from interface: XPathContext
      Wait for child threads started under the control of this context to finish. This is called at the end of the (main thread of a) transformation, and also at the end of the "try" part of a try/catch. The threads affected are those used to implement xsl:result-document instructions.
      Specified by:
      waitForChildThreads in interface XPathContext
      Throws:
      XPathException - if any of the child threads have failed with a dynamic error.

    • setTemporaryOutputState

      public void setTemporaryOutputState(int temporary)
      Description copied from interface: XPathContext
      Set the XSLT output state to "temporary" or "final"
      Specified by:
      setTemporaryOutputState in interface XPathContext
      Parameters:
      temporary - set non-zero to set temporary output state; zero to set final output state

    • getTemporaryOutputState

      public int getTemporaryOutputState()
      Ask whether the XSLT output state is "temporary" or "final"
      Specified by:
      getTemporaryOutputState in interface XPathContext
      Returns:
      non-zero in temporary output state; zero in final output state

    • setCurrentOutputUri

      public void setCurrentOutputUri(String uri)
      Set the current output URI
      Specified by:
      setCurrentOutputUri in interface XPathContext
      Parameters:
      uri - the current output URI, or null if in temporary output state

    • getCurrentOutputUri

      public String getCurrentOutputUri()
      Get the current output URI
      Specified by:
      getCurrentOutputUri in interface XPathContext
      Returns:
      the current output URI, or null if in temporary output state

    • getThreadManager

      public XPathContextMajor.ThreadManager getThreadManager()
      Get the thread manager used to process asynchronous xsl:result-document threads.
      Specified by:
      getThreadManager in interface XPathContext
      Returns:
      the current thread manager; or null if multithreading is not supported

    • getTargetComponent

      public Component getTargetComponent(int bindingSlot)
      Description copied from interface: XPathContext
      Bind a component reference to a component. This is used for binding component references (such as function calls, global variable references, or xsl:call-template) across package boundaries. The binding is done dynamically because, in the presence of overridden components, the choice among different components with the same name depends on which package the caller is in.
      Specified by:
      getTargetComponent in interface XPathContext
      Parameters:
      bindingSlot - Binding slots are allocated statically to the external component references in every component: for example, in the case of a template, to all global variable references, named function calls, and named template calls within that template. The binding slot therefore identifies the name of the component that is required; and the selection of an actual component is done by selection from the binding vector of the component currently being executed
      Returns:
      the component to be invoked