Package net.sf.saxon.expr
Interface XPathContext
-
- All Known Implementing Classes:
EarlyEvaluationContext
,XPathContextMajor
,XPathContextMinor
public interface XPathContext
This class represents a context in which an XPath expression is evaluated.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
changeOutputDestination(Receiver receiver, int validation, SchemaType schemaType)
Set a new output destination, supplying the output format details.ValueRepresentation
evaluateLocalVariable(int slotnumber)
Get the value of a local variable, identified by its slot numberXPathContext
getCaller()
Get the calling XPathContext (the next one down the stack).StringCollator
getCollation(java.lang.String name)
Get a named collation.Configuration
getConfiguration()
Get the ConfigurationItem
getContextItem()
Get the context itemController
getController()
Get the Controller.DateTimeValue
getCurrentDateTime()
Get the current date and timeXPathException
getCurrentException()
Get the current exception (in saxon:catch)GroupIterator
getCurrentGroupIterator()
Get the current group iterator.SequenceIterator
getCurrentIterator()
Get the current iterator.Mode
getCurrentMode()
Get the current mode.RegexIterator
getCurrentRegexIterator()
Get the current regex iterator.Rule
getCurrentTemplateRule()
Get the current template rule.int
getImplicitTimezone()
Get the implicit timezoneint
getLast()
Get the context size (the position of the last item in the current node list)ParameterSet
getLocalParameters()
Get the local (non-tunnel) parameters that were passed to the current function or templateNamePool
getNamePool()
Get the Name PoolSequenceReceiver
getReceiver()
Get the Receiver to which output is currently being written.StackFrame
getStackFrame()
Get a reference to the local stack frame for variables.ParameterSet
getTunnelParameters()
Get the tunnel parameters that were passed to the current function or template.boolean
isAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last().boolean
isTemporaryOutputState()
Ask whether the XSLT output state is "temporary" or "final"java.util.Iterator
iterateStackFrames()
Get the context stack.XPathContextMajor
newCleanContext()
Construct a new context without copying (used for the context in a function call)XPathContextMajor
newContext()
Construct a new context as a copy of another.XPathContextMinor
newMinorContext()
Construct a new minor context.void
setCaller(XPathContext caller)
Set the calling XPathContextvoid
setCurrentIterator(SequenceIterator iter)
Set a new sequence iterator.void
setLocalVariable(int slotnumber, ValueRepresentation value)
Set the value of a local variable, identified by its slot numbervoid
setReceiver(SequenceReceiver receiver)
Change the SequenceReceiver to which output is writtenint
useLocalParameter(int parameterId, int slotNumber, boolean isTunnel)
Use local parameter.
-
-
-
Method Detail
-
newContext
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- Returns:
- a new context, created as a copy of this context
-
newCleanContext
XPathContextMajor newCleanContext()
Construct a new context without copying (used for the context in a function call)- Returns:
- a new clean context
-
newMinorContext
XPathContextMinor newMinorContext()
Construct a new minor context. A minor context can only hold new values of the focus (currentIterator) and current output destination.- Returns:
- a new minor context
-
getLocalParameters
ParameterSet getLocalParameters()
Get the local (non-tunnel) parameters that were passed to the current function or template- Returns:
- a ParameterSet containing the local parameters
-
getTunnelParameters
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.- Returns:
- a ParameterSet containing the tunnel parameters
-
getController
Controller getController()
Get the Controller. May return null when running outside XSLT or XQuery- Returns:
- the controller for this query or transformation
-
getConfiguration
Configuration getConfiguration()
Get the Configuration- Returns:
- the Saxon configuration object
-
getNamePool
NamePool getNamePool()
Get the Name Pool- Returns:
- the name pool
-
setCaller
void setCaller(XPathContext caller)
Set the calling XPathContext- Parameters:
caller
- the XPathContext of the calling expression
-
getCaller
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.- Returns:
- the XPathContext of the calling expression
-
setCurrentIterator
void setCurrentIterator(SequenceIterator iter)
Set a new sequence iterator.- Parameters:
iter
- the current iterator. The context item, position, and size are determined by reference to the current iterator.
-
getCurrentIterator
SequenceIterator getCurrentIterator()
Get the current iterator. This encapsulates the context item, context position, and context size.- Returns:
- the current iterator, or null if there is no current iterator (which means the context item, position, and size are undefined).
-
getContextItem
Item getContextItem()
Get the context item- Returns:
- the context item, or null if the context item is undefined
-
getLast
int getLast() throws XPathException
Get the context size (the position of the last item in the current node list)- Returns:
- the context size
- Throws:
XPathException
- if the context position is undefined
-
isAtLast
boolean isAtLast() throws XPathException
Determine whether the context position is the same as the context size that is, whether position()=last(). In many cases this has better performance than a direct comparison, because it does not require reading to the end of the sequence.- Returns:
- true if the context position is the same as the context size.
- Throws:
XPathException
-
getCollation
StringCollator getCollation(java.lang.String name) throws XPathException
Get a named collation.Note: although collations are defined in the specification as being part of the static context, Saxon assumes that all available collations have global scope for a transformation or query, so that a collation URI can be translated into an actual collation without knowing where in the source code the collation URI was used. The default collation, however, can vary in different parts of a query or stylesheet, and expressions using the default collation must therefore get it from the static context.
- Parameters:
name
- the name (URI) of the required collation- Returns:
- a StringCollator representing the collation
- Throws:
XPathException
- if the collation is not recognized
-
useLocalParameter
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- Parameters:
parameterId
- Globally-unique parameter identifierslotNumber
- Slot number of the parameter within the stack frame of the called templateisTunnel
- True if a tunnel parameter is required, else false- Returns:
- ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED
- Throws:
XPathException
-
getStackFrame
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.- Returns:
- array of variables.
-
evaluateLocalVariable
ValueRepresentation evaluateLocalVariable(int slotnumber)
Get the value of a local variable, identified by its slot number- 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
void setLocalVariable(int slotnumber, ValueRepresentation value)
Set the value of a local variable, identified by its slot number- 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
void changeOutputDestination(Receiver receiver, int validation, SchemaType schemaType) throws XPathException
Set a new output destination, supplying the output format details.
Note that it is the caller's responsibility to close the Writer after use.- Parameters:
receiver
- the new output destinationvalidation
- validation mode: strict, lax, preserve, or stripschemaType
- type against which the output must be validated; null if not applicable- 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
-
isTemporaryOutputState
boolean isTemporaryOutputState()
Ask whether the XSLT output state is "temporary" or "final"- Returns:
- true to set temporary output state; false to set final output state
-
setReceiver
void setReceiver(SequenceReceiver receiver)
Change the SequenceReceiver to which output is written- Parameters:
receiver
- the SequenceReceiver to be used
-
getReceiver
SequenceReceiver getReceiver()
Get the Receiver to which output is currently being written.- Returns:
- the current SequenceReceiver
-
getCurrentMode
Mode getCurrentMode()
Get the current mode.- Returns:
- the current mode
-
getCurrentTemplateRule
Rule getCurrentTemplateRule()
Get the current template rule. This is used to support xsl:apply-imports and xsl:next-match- Returns:
- the current template rule
-
getCurrentGroupIterator
GroupIterator getCurrentGroupIterator()
Get the current group iterator. This supports the current-group() and current-grouping-key() functions in XSLT 2.0- Returns:
- the current grouped collection
-
getCurrentRegexIterator
RegexIterator getCurrentRegexIterator()
Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.- Returns:
- the current regular expressions iterator
-
getCurrentDateTime
DateTimeValue getCurrentDateTime() throws NoDynamicContextException
Get the current date and time- Returns:
- the current date and time. All calls within a single query or transformation will return the same value
- Throws:
NoDynamicContextException
-
getImplicitTimezone
int getImplicitTimezone() throws NoDynamicContextException
Get the implicit timezone- Returns:
- the implicit timezone. This will be the timezone of the current date and time, and all calls within a single query or transformation will return the same value. The result is expressed as an offset from UTC in minutes.
- Throws:
NoDynamicContextException
-
iterateStackFrames
java.util.Iterator 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.- Returns:
- an iterator over a copy of the run-time call stack
-
getCurrentException
XPathException getCurrentException()
Get the current exception (in saxon:catch)- Returns:
- the current exception, or null if there is none defined
-
-