Package net.sf.saxon.expr
Class XPathContextMinor
java.lang.Object
net.sf.saxon.expr.XPathContextMinor
- All Implemented Interfaces:
XPathContext
- Direct Known Subclasses:
XPathContextMajor
This class represents a minor change in the dynamic 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 TypeClassDescriptionprotected static class
Container for cached value of the last() function. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) XPathContext
(package private) Controller
(package private) XPathException
(package private) SequenceIterator
(package private) SequenceReceiver
(package private) XPathContextMinor.LastValue
protected StackFrame
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
changeOutputDestination
(Receiver receiver, int validation, SchemaType schemaType) Set a new output destination, supplying the output format details.final ValueRepresentation
evaluateLocalVariable
(int slotnumber) Get the value of a local variable, identified by its slot numberfinal XPathContext
Get the calling XPathContext (the next one down the stack).final StringCollator
getCollation
(String name) Get a named collationfinal Configuration
Get the Configurationfinal Item
Get the context itemfinal Controller
Get the Controller.Get the current date and time for this query or transformation.Get the current exception (in saxon:catch)Get the current group iterator.final SequenceIterator
Get the current iterator.Get the current mode.Get the current regex iterator.Get the current template.final int
Get the implicit timezone, as a positive or negative offset from UTC in minutes.final int
getLast()
Get the context size (the position of the last item in the current node list)Get the local parameters for the current template call.final NameChecker
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriatefinal NamePool
Get the Name Poolfinal SequenceReceiver
Get the Receiver to which output is currently being written.Get a reference to the local stack frame for variables.Get the tunnel parameters for the current template call.final boolean
isAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last()boolean
Ask whether the XSLT output state is "temporary" or "final"Get the context stack.Construct a new context without copying (used for the context in a function call)Construct a new context as a copy of another.Construct a new context as a copy of another.void
setCaller
(XPathContext caller) Set the calling XPathContextvoid
setCurrentException
(XPathException exception) Set the current exception (in saxon:catch)void
Set a new sequence iterator.final void
setLocalVariable
(int slotnumber, ValueRepresentation value) Set the value of a local variable, identified by its slot numbervoid
setReceiver
(SequenceReceiver receiver) Change the Receiver to which output is writtenint
useLocalParameter
(int parameterId, int slotNumber, boolean isTunnel) Use local parameter.
-
Field Details
-
controller
Controller controller -
currentIterator
SequenceIterator currentIterator -
last
-
currentReceiver
SequenceReceiver currentReceiver -
caller
XPathContext caller -
stackFrame
-
currentException
XPathException currentException
-
-
Constructor Details
-
XPathContextMinor
protected XPathContextMinor()Private Constructor
-
-
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
- Returns:
- a new context, created as a copy of this context
-
newMinorContext
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:
newMinorContext
in interfaceXPathContext
- Returns:
- a new minor context
-
setCaller
Set the calling XPathContext- Specified by:
setCaller
in interfaceXPathContext
- Parameters:
caller
- the XPathContext of the calling expression
-
newCleanContext
Construct a new context without copying (used for the context in a function call)- Specified by:
newCleanContext
in interfaceXPathContext
- Returns:
- a new clean context
-
getLocalParameters
Get the local parameters for the current template call.- Specified by:
getLocalParameters
in interfaceXPathContext
- Returns:
- the supplied parameters
-
getTunnelParameters
Get the tunnel parameters for the current template call.- Specified by:
getTunnelParameters
in interfaceXPathContext
- Returns:
- the supplied tunnel parameters
-
getController
Get the Controller. May return null when running outside XSLT or XQuery- Specified by:
getController
in interfaceXPathContext
- Returns:
- the controller for this query or transformation
-
getConfiguration
Get the Configuration- Specified by:
getConfiguration
in interfaceXPathContext
- Returns:
- the Saxon configuration object
-
getNamePool
Get the Name Pool- Specified by:
getNamePool
in interfaceXPathContext
- Returns:
- the name pool
-
getNameChecker
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate- Returns:
- the appropriate name checker
-
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 interfaceXPathContext
- Returns:
- the XPathContext of the calling expression
-
setCurrentIterator
Set a new sequence iterator.- Specified by:
setCurrentIterator
in interfaceXPathContext
- Parameters:
iter
- the current iterator. The context item, position, and size are determined by reference to the current iterator.
-
getCurrentIterator
Get the current iterator. This encapsulates the context item, context position, and context size.- Specified by:
getCurrentIterator
in interfaceXPathContext
- Returns:
- the current iterator, or null if there is no current iterator (which means the context item, position, and size are undefined).
-
getContextItem
Get the context item- Specified by:
getContextItem
in interfaceXPathContext
- Returns:
- the context item, or null if the context item is undefined
-
getLast
Get the context size (the position of the last item in the current node list)- Specified by:
getLast
in interfaceXPathContext
- Returns:
- the context size
- Throws:
XPathException
- if the context position is undefined
-
isAtLast
Determine whether the context position is the same as the context size that is, whether position()=last()- Specified by:
isAtLast
in interfaceXPathContext
- Returns:
- true if the context position is the same as the context size.
- Throws:
XPathException
-
getCollation
Get a named collation- Specified by:
getCollation
in interfaceXPathContext
- Parameters:
name
- the name (URI) of the required collation- Returns:
- a StringCollator representing the collation
- Throws:
XPathException
- if the collation is not recognized
-
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 interfaceXPathContext
- Returns:
- array of variables.
-
evaluateLocalVariable
Get the value of a local variable, identified by its slot number- Specified by:
evaluateLocalVariable
in interfaceXPathContext
- 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.
-
setLocalVariable
Set the value of a local variable, identified by its slot number- Specified by:
setLocalVariable
in interfaceXPathContext
- Parameters:
slotnumber
- the slot number allocated at compile time to the variable, which identifies its position within the local stack framevalue
- the value of the variable
-
changeOutputDestination
public void changeOutputDestination(Receiver receiver, int validation, SchemaType schemaType) throws XPathException Set a new output destination, supplying the output format details.
This affects all further output until resetOutputDestination() is called. Note that it is the caller's responsibility to close the Writer after use.- Specified by:
changeOutputDestination
in interfaceXPathContext
- Parameters:
schemaType
- schema type against which the output is to be validated, if anyreceiver
- the new output destinationvalidation
- validation mode: strict, lax, preserve, or strip- Throws:
XPathException
- if any dynamic error occurs; and specifically, if an attempt is made to switch to a final output destination while writing a temporary tree or sequence @param isFinal true if the destination is a final result tree (either the principal output or a secondary result tree); false if @param validation Validation to be performed on the output document
-
setReceiver
Change the Receiver to which output is written- Specified by:
setReceiver
in interfaceXPathContext
- Parameters:
receiver
- the SequenceReceiver to be used
-
getReceiver
Get the Receiver to which output is currently being written.- Specified by:
getReceiver
in interfaceXPathContext
- Returns:
- the current Receiver
-
isTemporaryOutputState
public boolean isTemporaryOutputState()Ask whether the XSLT output state is "temporary" or "final"- Specified by:
isTemporaryOutputState
in interfaceXPathContext
- Returns:
- true to set temporary output state; false to set final output state
-
useLocalParameter
public int useLocalParameter(int parameterId, 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
- Parameters:
parameterId
-slotNumber
-isTunnel
- True if a tunnel parameter is required, else false @return ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED- Returns:
- ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED
- Throws:
XPathException
-
getCurrentMode
Get the current mode.- Specified by:
getCurrentMode
in interfaceXPathContext
- Returns:
- the current mode
-
getCurrentTemplateRule
Get the current template. This is used to support xsl:apply-imports- Specified by:
getCurrentTemplateRule
in interfaceXPathContext
- Returns:
- the current template
-
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
- Returns:
- the current grouped collection
-
getCurrentRegexIterator
Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.- Specified by:
getCurrentRegexIterator
in interfaceXPathContext
- Returns:
- the current regular expressions iterator
-
getCurrentDateTime
Get the current date and time for this query or transformation. All calls during one transformation return the same answer.- Specified by:
getCurrentDateTime
in interfaceXPathContext
- Returns:
- Get the current date and time. This will deliver the same value for repeated calls within the same transformation
-
getImplicitTimezone
public final int getImplicitTimezone()Get the implicit timezone, as a positive or negative offset from UTC in minutes. The range is -14hours to +14hours- Specified by:
getImplicitTimezone
in interfaceXPathContext
- Returns:
- the implicit timezone as an offset from UTC in minutes
-
iterateStackFrames
Get the context stack. This method returns an iterator whose items are instances ofContextStackFrame
, 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 interfaceXPathContext
- Returns:
- an iterator over a copy of the run-time call stack
-
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
- Returns:
- the current exception, or null if there is none defined
-