Package net.sf.saxon.expr
Class XPathContextMajor
java.lang.Object
net.sf.saxon.expr.XPathContextMinor
net.sf.saxon.expr.XPathContextMajor
- All Implemented Interfaces:
XPathContext
This class represents a "major context" in which an XPath expression is evaluated:
a "major context" object allows all aspects of the dynamic context to change, whereas
a "minor context" only allows changes to the focus and the destination for push output.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
The ThreadManager is used to manage asynchronous execution of xsl:result-document instructions in Saxon-EE.Nested classes/interfaces inherited from class net.sf.saxon.expr.XPathContextMinor
XPathContextMinor.LastValue
-
Field Summary
Fields inherited from class net.sf.saxon.expr.XPathContextMinor
currentDestination, stackFrame, temporaryOutputState
-
Constructor Summary
ConstructorsConstructorDescriptionXPathContextMajor
(Controller controller) Constructor should only be called by the Controller, which acts as a XPathContext factory.XPathContextMajor
(Item item, Executable exec) Constructor for use in free-standing Java applications. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Create a new thread manager.Sequence[]
Get a all the variables in the stack frameGet the current componentGet the current exception (in saxon:catch)Get the current group iterator.Get the current merge group iterator.Get the current mode.Get the current regex iterator.Get the current template.Get the error reporter.Get the local parameters for the current template call.Get information about the creating expression or other construct.Get the resource resolver.Determine whether the body of a function is to be repeated, due to tail-recursive function callsgetTargetComponent
(int bindingSlot) Bind a component reference to a component.Get the thread manager in use for this context.Get the tunnel parameters for the current template call.Construct a new context as a copy of another.static XPathContextMajor
newContext
(XPathContextMinor prev) Create a new "major" context (one that is capable of holding a stack frame with local variablesstatic XPathContextMajor
Make a copy of the supplied context for use in a new thread (typically for an asynchronous xsl:result-document)void
openStackFrame
(int numberOfVariables) Create a new stack frame large enough to hold a given number of local variables, for which no stack frame map is available.void
Create a new stack frame for local variables, using the supplied SlotManager to define the allocation of slots to individual variablesvoid
requestTailCall
(TailCallLoop.TailCallInfo targetFn, Sequence[] variables) Reset the local stack frame.void
resetAllVariableValues
(Sequence[] values) Overwrite all the variables in the stack framevoid
resetParameterValues
(Sequence[] values) Overwrite all the parameters in the stack frame.void
resetStackFrameMap
(SlotManager map, int numberOfParams) Reset the stack frame variable map, while reusing the StackFrame object itself.void
setCurrentComponent
(Component component) Set the current component, that is, the component being evaluated.void
setCurrentException
(XPathException exception) Set the current exception (in saxon:catch)void
setCurrentGroupIterator
(GroupIterator iterator) Set the current grouping iterator.void
setCurrentMergeGroupIterator
(GroupIterator iterator) Set the current merge group iterator.void
setCurrentMode
(Component.M mode) Set the current mode.void
setCurrentRegexIterator
(RegexIterator iterator) Set the current regex iterator.void
setCurrentTemplateRule
(Rule rule) Set the current template.void
setErrorReporter
(ErrorReporter reporter) Set the error reporter.void
setLocalParameters
(ParameterSet localParameters) Set the local parameters for the current template call.void
setOrigin
(ContextOriginator expr) Set the creating expression (for use in diagnostics).void
setResourceResolver
(ResourceResolver resolver) void
setStackFrame
(SlotManager map, Sequence[] variables) Set the local stack frame.void
setTunnelParameters
(ParameterSet tunnelParameters) Set the tunnel parameters for the current template call.int
useLocalParameter
(StructuredQName paramName, int slotNumber, boolean isTunnel) Use local parameter.void
Wait for child threads started under the control of this context to finish.Methods inherited from class net.sf.saxon.expr.XPathContextMinor
evaluateLocalVariable, getCaller, getConfiguration, getContextItem, getController, getCurrentDateTime, getCurrentIterator, getCurrentOutputUri, getImplicitTimezone, getLast, getMajorContext, getNamePool, getStackFrame, getTemporaryOutputState, isAtLast, iterateStackFrames, makeStackFrameMutable, newCleanContext, newMinorContext, setCaller, setCurrentIterator, setCurrentOutputUri, setLocalVariable, setTemporaryOutputState, trackFocus, trackFocusMultithreaded
-
Constructor Details
-
XPathContextMajor
Constructor should only be called by the Controller, which acts as a XPathContext factory.- Parameters:
controller
- the Controller
-
XPathContextMajor
Constructor for use in free-standing Java applications.- Parameters:
item
- the item to use as the initial context item. If this is null, the comtext item is initially undefined (which will cause a dynamic error if it is referenced).exec
- the Executable
-
-
Method Details
-
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 interfaceXPathContext
- Overrides:
newContext
in classXPathContextMinor
- Returns:
- a new context, created as a copy of this context
-
newContext
Create a new "major" context (one that is capable of holding a stack frame with local variables- Parameters:
prev
- the previous context (the one causing the new context to be created)- Returns:
- the new major context
-
newThreadContext
Make a copy of the supplied context for use in a new thread (typically for an asynchronous xsl:result-document)- Parameters:
prev
- the context to be copied- Returns:
- the copy of the context
-
getThreadManager
Get the thread manager in use for this context.- Specified by:
getThreadManager
in interfaceXPathContext
- Overrides:
getThreadManager
in classXPathContextMinor
- Returns:
- the current thread manager. This will be null if not running XSLT under Saxon-EE
-
createThreadManager
public void createThreadManager()Create a new thread manager. This is called when starting an XSLT Transformation, and also when entering a try/catch block. In Saxon-HE it does nothing. -
waitForChildThreads
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 interfaceXPathContext
- Overrides:
waitForChildThreads
in classXPathContextMinor
- Throws:
XPathException
- if any of the child threads have failed with a dynamic error.
-
getLocalParameters
Get the local parameters for the current template call.- Specified by:
getLocalParameters
in interfaceXPathContext
- Overrides:
getLocalParameters
in classXPathContextMinor
- Returns:
- the supplied parameters
-
setLocalParameters
Set the local parameters for the current template call.- Parameters:
localParameters
- the supplied parameters
-
getTunnelParameters
Get the tunnel parameters for the current template call.- Specified by:
getTunnelParameters
in interfaceXPathContext
- Overrides:
getTunnelParameters
in classXPathContextMinor
- Returns:
- the supplied tunnel parameters
-
setTunnelParameters
Set the tunnel parameters for the current template call.- Parameters:
tunnelParameters
- the supplied tunnel parameters
-
setOrigin
Set the creating expression (for use in diagnostics). The origin is generally set to "this" by the object that creates the new context. It's up to the debugger to determine whether this information is useful. The object will either be anExpression
, allowing information about the calling instruction to be obtained, or null.- Parameters:
expr
- the originator of this context object
-
getOrigin
Get information about the creating expression or other construct.- Returns:
- the originator of this context, or null if not known
-
setStackFrame
Set the local stack frame. This method is used when creating a Closure to support delayed evaluation of expressions. The "stack frame" is actually on the Java heap, which means it can survive function returns and the like.- Parameters:
map
- the SlotManager, which holds static details of the allocation of variables to slotsvariables
- the array of "slots" to hold the actual variable values. This array will be copied if it is too small to hold all the variables defined in the SlotManager
-
resetStackFrameMap
Reset the stack frame variable map, while reusing the StackFrame object itself. This is done on a tail call to a different function- Parameters:
map
- the SlotManager representing the stack frame contentsnumberOfParams
- the number of parameters required on the new stack frame
-
getAllVariableValues
Get a all the variables in the stack frame- Returns:
- an array holding all the variables, each referenceable by its slot number
-
resetAllVariableValues
Overwrite all the variables in the stack frame- Parameters:
values
- an array holding all the variables, each referenceable by its slot number; the caller must ensure this is the correct length (and valid in other ways)
-
resetParameterValues
Overwrite all the parameters in the stack frame. (Used from compiled bytecode)- Parameters:
values
- an array holding all the parameters, each referenceable by its slot number; the caller must ensure this is the correct length (and valid in other ways)
-
requestTailCall
Reset the local stack frame. This method is used when processing a tail-recursive function. Instead of the function being called recursively, the parameters are set to new values and the function body is evaluated repeatedly- Parameters:
targetFn
- the user function being called using tail recursionvariables
- the parameter to be supplied to the user function
-
getTailCallInfo
Determine whether the body of a function is to be repeated, due to tail-recursive function calls- Returns:
- null if no tail call has been requested, or the name of the function to be called otherwise
-
openStackFrame
Create a new stack frame for local variables, using the supplied SlotManager to define the allocation of slots to individual variables- Parameters:
map
- the SlotManager for the new stack frame
-
openStackFrame
public void openStackFrame(int numberOfVariables) Create a new stack frame large enough to hold a given number of local variables, for which no stack frame map is available. This is used in particular when evaluating match patterns of template rules.- Parameters:
numberOfVariables
- The number of local variables to be accommodated.
-
setCurrentMode
Set the current mode.- Parameters:
mode
- the new current mode
-
getCurrentMode
Get the current mode.- Specified by:
getCurrentMode
in interfaceXPathContext
- Overrides:
getCurrentMode
in classXPathContextMinor
- Returns:
- the current mode. May return null if the current mode is the default mode.
-
setCurrentTemplateRule
Set the current template. This is used to support xsl:apply-imports. The caller is responsible for remembering the previous current template and resetting it after use.- Parameters:
rule
- the current template rule, or null to indicate that there is no current template rule
-
getCurrentTemplateRule
Get the current template. This is used to support xsl:apply-imports- Specified by:
getCurrentTemplateRule
in interfaceXPathContext
- Overrides:
getCurrentTemplateRule
in classXPathContextMinor
- Returns:
- the current template
-
setCurrentGroupIterator
Set the current grouping iterator. This supports the current-group() and current-grouping-key() functions in XSLT 2.0- Parameters:
iterator
- the new current 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 interfaceXPathContext
- Overrides:
getCurrentGroupIterator
in classXPathContextMinor
- Returns:
- the current grouped collection
-
setCurrentMergeGroupIterator
Set the current merge group iterator. This supports the current-merge-group() and current-merge-key() functions in XSLT 3.0- Parameters:
iterator
- the new current 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 interfaceXPathContext
- Overrides:
getCurrentMergeGroupIterator
in classXPathContextMinor
- Returns:
- the current grouped collection
-
setCurrentRegexIterator
Set the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.- Parameters:
iterator
- the current regex iterator
-
getCurrentRegexIterator
Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.- Specified by:
getCurrentRegexIterator
in interfaceXPathContext
- Overrides:
getCurrentRegexIterator
in classXPathContextMinor
- Returns:
- the current regular expressions iterator
-
useLocalParameter
public int useLocalParameter(StructuredQName paramName, int slotNumber, boolean isTunnel) throws XPathException 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 interfaceXPathContext
- Overrides:
useLocalParameter
in classXPathContextMinor
- Parameters:
paramName
- the name of the parameterslotNumber
- the slot number of the parameter on the callee's stack frameisTunnel
- True if a tunnel parameter is required, else false- Returns:
- ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED
- Throws:
XPathException
- if an error is detected
-
setResourceResolver
-
getResourceResolver
Get the resource 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 interfaceXPathContext
- Overrides:
getResourceResolver
in classXPathContextMinor
- Returns:
- the user-supplied URI resolver if there is one, or null otherwise.
- Since:
- 11.1 (replaces getURIResolver())
-
setErrorReporter
Set the error reporter. The ErrorReporter is set locally to this XPathContext object.- Parameters:
reporter
- the ErrorReporter to be used- Since:
- 9.6. Changed in 10.0 to use the ErrorReporter interface in place of ErrorListener
-
getErrorReporter
Get the error reporter. If no ErrorReporter has been set locally, the ErrorReporter in the Controller is returned; this in turn defaults to the ErrorReporter set in the Configuration.- Specified by:
getErrorReporter
in interfaceXPathContext
- Overrides:
getErrorReporter
in classXPathContextMinor
- Returns:
- the ErrorReporter in use.
- Since:
- 9.6. Changed in 10.0 to use an ErrorReporter rather than ErrorListener
-
setCurrentException
Set the current exception (in saxon:catch)- Parameters:
exception
- the current exception
-
getCurrentException
Get the current exception (in saxon:catch)- Specified by:
getCurrentException
in interfaceXPathContext
- Overrides:
getCurrentException
in classXPathContextMinor
- Returns:
- the current exception, or null if there is none defined
-
getCurrentComponent
Get the current component- Specified by:
getCurrentComponent
in interfaceXPathContext
- Overrides:
getCurrentComponent
in classXPathContextMinor
- Returns:
- the current component
-
setCurrentComponent
Set the current component, that is, the component being evaluated. This is used during the evaluation to determine the bindings to other components (such as global variables, functions, and templates) referenced during the evaluation- Parameters:
component
- the current component
-
getTargetComponent
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 interfaceXPathContext
- Overrides:
getTargetComponent
in classXPathContextMinor
- 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
-