This class represents a context in which an XPath expression is evaluated.
changeOutputDestination
public void changeOutputDestination(Properties props,
Result result,
boolean isFinal,
int hostLanguage,
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.
props
- properties defining the output formatresult
- Details of the new output destinationisFinal
- true if the destination is a final result tree
(either the principal output or a secondary result tree); false if nothostLanguage
- typically XSLT or XQueryvalidation
- validation mode: strict, lax, preserve, or stripschemaType
- type against which the output must be validated
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
evaluateLocalVariable
public ValueRepresentation evaluateLocalVariable(int slotnumber)
Get the value of a local variable, identified by its slot number
slotnumber
- the slot number allocated at compile time to the variable,
which identifies its position within the local stack frame
- 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.
- the XPathContext of the calling expression
getCollation
public StringCollator getCollation(String name)
throws XPathException
Get a named collation
name
- the name (URI) of the required collation
- a StringCollator representing the collation
getConfiguration
public Configuration getConfiguration()
Get the Configuration
- the Saxon configuration object
getContextItem
public Item getContextItem()
Get the context item
- the context item, or null if the context item is undefined
getContextPosition
public int getContextPosition()
throws XPathException
Get the context position (the position of the context item)
- the context position (starting at one)
getController
public Controller getController()
Get the Controller. May return null when running outside XSLT or XQuery
- the controller for this query or transformation
getCurrentDateTime
public DateTimeValue getCurrentDateTime()
throws NoDynamicContextException
Get the current date and time
- the current date and time. All calls within a single query or transformation
will return the same value
getCurrentGroupIterator
public GroupIterator getCurrentGroupIterator()
Get the current group iterator. This supports the current-group() and
current-grouping-key() functions in XSLT 2.0
- the current grouped collection
getCurrentIterator
public SequenceIterator getCurrentIterator()
Get the current iterator.
This encapsulates the context item, context position, and context size.
- the current iterator, or null if there is no current iterator
(which means the context item, position, and size are undefined).
getCurrentMode
public Mode getCurrentMode()
Get 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.
- the current regular expressions iterator
getCurrentTemplateRule
public Rule getCurrentTemplateRule()
Get the current template rule. This is used to support xsl:apply-imports and xsl:next-match
- the current template rule
getDefaultCollation
public StringCollator getDefaultCollation()
Get the default collation
- a StringCollator representing the default collation
getImplicitTimezone
public int getImplicitTimezone()
throws NoDynamicContextException
Get the implicit timezone
- 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.
getLast
public int getLast()
throws XPathException
Get the context size (the position of the last item in the current node list)
getLocalParameters
public ParameterSet getLocalParameters()
Get the local (non-tunnel) parameters that were passed to the current function or template
- a ParameterSet containing the local parameters
getNamePool
public NamePool getNamePool()
Get the Name Pool
getOrigin
public InstructionInfoProvider getOrigin()
Get information about the creating expression or other construct.
- information about the creating expression
getOriginatingConstructType
public int getOriginatingConstructType()
Get the type of location from which this context was created.
- the type of location. (The integer codes that are used are often fingerprints of instruction
names, but not always. For details of the codes, see the standard trace listener which interprets them)
getReceiver
public SequenceReceiver getReceiver()
Get the Receiver to which output is currently being written.
- the current SequenceReceiver
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.
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.
- 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(). In many cases this has better performance
than a direct comparison, because it does not require reading to the end of the
sequence.
- true if the context position is the same as the context size.
newCleanContext
public XPathContextMajor newCleanContext()
Construct a new context without copying (used for the context in a function call)
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
- 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.
setCaller
public void setCaller(XPathContext caller)
Set the calling XPathContext
caller
- the XPathContext of the calling expression
setCurrentIterator
public void setCurrentIterator(SequenceIterator iter)
Set a new sequence iterator.
iter
- the current iterator. The context item, position, and size are determined by reference
to the current iterator.
setLocalVariable
public void setLocalVariable(int slotnumber,
ValueRepresentation value)
Set the value of a local variable, identified by its slot number
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
setOrigin
public void setOrigin(InstructionInfoProvider expr)
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. Where possible, the object will be an
InstructionInfoProvider
, allowing information
about the calling instruction to be obtained.
expr
- the expression that created this context object
setOriginatingConstructType
public void setOriginatingConstructType(int loc)
loc
- The originating location: the argument must be one of the integer constants in class
Location
setReceiver
public void setReceiver(SequenceReceiver receiver)
Change the SequenceReceiver to which output is written
receiver
- the SequenceReceiver to be used
setTemporaryReceiver
public void setTemporaryReceiver(SequenceReceiver out)
Set the SequenceReceiver to which output is to be written, marking it as a temporary (non-final)
output destination.
out
- The SequenceReceiver to be used
useLocalParameter
public boolean useLocalParameter(StructuredQName qName,
LocalParam binding,
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
qName
- The fingerprint of the parameter namebinding
- The XSLParam element to bind its value toisTunnel
- True if a tunnel parameter is required, else false
- true if a parameter of this name was supplied, false if not