net.sf.saxon.expr

Class XPathContextMinor

public class XPathContextMinor extends Object implements XPathContext

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.

Field Summary
XPathContext	caller
Controller	controller
XPathException	currentException
SequenceIterator	currentIterator
SequenceReceiver	currentReceiver
boolean	isTemporaryDestination
XPathContextMinor.LastValue	last
Object	origin
protected StackFrame	stackFrame

Constructor Summary
protected	XPathContextMinor() Private Constructor

Method Summary
void	changeOutputDestination(Receiver receiver, boolean isFinal, 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 number
XPathContext	getCaller() Get the calling XPathContext (the next one down the stack).
StringCollator	getCollation(String name) Get a named collation
Configuration	getConfiguration() Get the Configuration
Item	getContextItem() Get the context item
int	getContextPosition() Get the context position (the position of the context item)
Controller	getController() Get the Controller.
DateTimeValue	getCurrentDateTime() Get the current date and time for this query or transformation.
XPathException	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.
int	getImplicitTimezone() Get the implicit timezone, as a positive or negative offset from UTC in minutes.
int	getLast() Get the context size (the position of the last item in the current node list)
ParameterSet	getLocalParameters() Get the local parameters for the current template call.
NameChecker	getNameChecker() Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate
NamePool	getNamePool() Get the Name Pool
InstructionInfo	getOrigin() Get information about the creating expression or other construct.
int	getOriginatingConstructType() Get the type of location from which this context was created.
SequenceReceiver	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 for the current template call.
boolean	isAtLast() Determine whether the context position is the same as the context size that is, whether position()=last()
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()
void	setCaller(XPathContext caller) Set the calling XPathContext
void	setCurrentException(XPathException exception) Set the current exception (in saxon:catch)
void	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 number
void	setOrigin(InstructionInfo expr) Set the creating expression (for use in diagnostics).
void	setOriginatingConstructType(int loc) Set the type of creating expression (for use in diagnostics).
void	setReceiver(SequenceReceiver receiver) Change the Receiver to which output is written
void	setTemporaryOutputState(boolean temp) Mark the context as being in (or not in) temporary output state
void	setTemporaryReceiver(SequenceReceiver out) Set the output destination to write to a sequence.
int	useLocalParameter(StructuredQName qName, LocalParam binding, boolean isTunnel) Use local parameter.

Field Detail

caller

XPathContext caller

controller

Controller controller

currentException

XPathException currentException

currentIterator

SequenceIterator currentIterator

currentReceiver

SequenceReceiver currentReceiver

isTemporaryDestination

boolean isTemporaryDestination

last

XPathContextMinor.LastValue last

origin

Object origin

stackFrame

protected StackFrame stackFrame

Constructor Detail

XPathContextMinor

protected XPathContextMinor()

Private Constructor

Method Detail

changeOutputDestination

public void changeOutputDestination(Receiver receiver, boolean isFinal, int validation, SchemaType schemaType)

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.

Parameters: validation Validation to be performed on the output document schemaType schema type against which the output is to be validated, if any

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

evaluateLocalVariable

public ValueRepresentation evaluateLocalVariable(int slotnumber)

Get the value of a local variable, identified by its slot number

getCaller

public final 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.

getCollation

public final StringCollator getCollation(String name)

Get a named collation

Throws: XPathException if the collation is not recognized

getConfiguration

public final Configuration getConfiguration()

Get the Configuration

getContextItem

public final Item getContextItem()

Get the context item

Returns: the context item, or null if the context item is undefined

getContextPosition

public final int getContextPosition()

Get the context position (the position of the context item)

Returns: the context position (starting at one)

Throws: XPathException if the context position is undefined

getController

public final Controller getController()

Get the Controller. May return null when running outside XSLT or XQuery

getCurrentDateTime

public DateTimeValue getCurrentDateTime()

Get the current date and time for this query or transformation. All calls during one transformation return the same answer.

Returns: Get the current date and time. This will deliver the same value for repeated calls within the same transformation

getCurrentException

public XPathException getCurrentException()

Get the current exception (in saxon:catch)

Returns: the current exception, or null if there is none defined

getCurrentGroupIterator

public 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

getCurrentIterator

public final 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).

getCurrentMode

public Mode getCurrentMode()

Get the current mode.

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.

Returns: the current regular expressions iterator

getCurrentTemplateRule

public Rule getCurrentTemplateRule()

Get the current template. This is used to support xsl:apply-imports

Returns: the current template

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

Returns: the implicit timezone as an offset from UTC in minutes

getLast

public final int getLast()

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

getLocalParameters

public ParameterSet getLocalParameters()

Get the local parameters for the current template call.

Returns: the supplied parameters

getNameChecker

public final NameChecker getNameChecker()

Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate

Returns: the appropriate name checker

getNamePool

public final NamePool getNamePool()

Get the Name Pool

getOrigin

public InstructionInfo getOrigin()

Get information about the creating expression or other construct.

getOriginatingConstructType

public int getOriginatingConstructType()

Get the type of location from which this context was created.

getReceiver

public final SequenceReceiver getReceiver()

Get the Receiver to which output is currently being written.

Returns: the current Receiver

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.

Returns: array of variables.

getTunnelParameters

public ParameterSet getTunnelParameters()

Get the tunnel parameters for the current template call.

Returns: the supplied tunnel parameters

isAtLast

public final boolean isAtLast()

Determine whether the context position is the same as the context size that is, whether position()=last()

iterateStackFrames

public Iterator 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.

Returns: an iterator over a copy of the run-time call stack

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

newMinorContext

public XPathContextMinor newMinorContext()

setCaller

public void setCaller(XPathContext caller)

Set the calling XPathContext

setCurrentException

public void setCurrentException(XPathException exception)

Set the current exception (in saxon:catch)

Parameters: exception the current exception

setCurrentIterator

public void setCurrentIterator(SequenceIterator iter)

Set a new sequence iterator.

setLocalVariable

public void setLocalVariable(int slotnumber, ValueRepresentation value)

Set the value of a local variable, identified by its slot number

setOrigin

public void setOrigin(InstructionInfo 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 Expression, allowing information about the calling instruction to be obtained.

setOriginatingConstructType

public void setOriginatingConstructType(int loc)

Set the type of creating expression (for use in diagnostics). When a new context is created, either this method or XPathContext should be called.

Parameters: loc The originating location: the argument must be one of the integer constants in class Location

setReceiver

public void setReceiver(SequenceReceiver receiver)

Change the Receiver to which output is written

setTemporaryOutputState

public void setTemporaryOutputState(boolean temp)

Mark the context as being in (or not in) temporary output state

Parameters: temp true to set temporary output state; false to unset it

setTemporaryReceiver

public void setTemporaryReceiver(SequenceReceiver out)

Set the output destination to write to a sequence.
This affects all further output until resetOutputDestination() is called.

Parameters: out The SequenceReceiver to be used

useLocalParameter

public int useLocalParameter(StructuredQName qName, LocalParam binding, 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

Parameters: qName The fingerprint of the parameter name binding The XSLParam element to bind its value to isTunnel True if a tunnel parameter is required, else false

Returns: ParameterSet.NOT_SUPPLIED, ParameterSet.SUPPLIED, or ParameterSet.SUPPLIED_AND_CHECKED