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
XPathContextcaller
Controllercontroller
SequenceIteratorcurrentIterator
SequenceReceivercurrentReceiver
booleanisTemporaryDestination
intlast
Objectorigin
Constructor Summary
protected XPathContextMinor()
Private Constructor
Method Summary
voidchangeOutputDestination(Properties props, Result result, boolean isFinal, int hostLanguage, int validation, SchemaType schemaType)
Set a new output destination, supplying the output format details.
ValueRepresentationevaluateLocalVariable(int slotnumber)
Get the value of a local variable, identified by its slot number
XPathContextgetCaller()
Get the calling XPathContext (the next one down the stack).
ComparatorgetCollation(String name)
Get a named collation
ConfigurationgetConfiguration()
Get the Configuration
ItemgetContextItem()
Get the context item
intgetContextPosition()
Get the context position (the position of the context item)
ControllergetController()
Get the Controller.
GroupIteratorgetCurrentGroupIterator()
Get the current group iterator.
SequenceIteratorgetCurrentIterator()
Get the current iterator.
ModegetCurrentMode()
Get the current mode.
RegexIteratorgetCurrentRegexIterator()
Get the current regex iterator.
TemplategetCurrentTemplate()
Get the current template.
ComparatorgetDefaultCollation()
Get the default collation
intgetImplicitTimezone()
Get the implicit timezone, as a positive or negative offset from UTC in minutes.
intgetLast()
Get the context size (the position of the last item in the current node list)
ParameterSetgetLocalParameters()
Get the local parameters for the current template call.
NameCheckergetNameChecker()
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate
NamePoolgetNamePool()
Get the Name Pool
InstructionInfoProvidergetOrigin()
Get information about the creating expression or other construct.
intgetOriginatingConstructType()
Get the type of location from which this context was created.
SequenceReceivergetReceiver()
Get the Receiver to which output is currently being written.
StackFramegetStackFrame()
Get a reference to the local stack frame for variables.
ParameterSetgetTunnelParameters()
Get the tunnel parameters for the current template call.
XPathContextMajor.XSLTContextgetXSLTContext()
Get the XSLT-specific part of the context
booleanisAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last()
XPathContextMajornewCleanContext()
Construct a new context without copying (used for the context in a function call)
XPathContextMajornewContext()
Construct a new context as a copy of another.
XPathContextMinornewMinorContext()
voidsetCaller(XPathContext caller)
Set the calling XPathContext
voidsetCurrentIterator(SequenceIterator iter)
Set a new sequence iterator.
voidsetLocalVariable(int slotnumber, ValueRepresentation value)
Set the value of a local variable, identified by its slot number
voidsetOrigin(InstructionInfoProvider expr)
Set the creating expression (for use in diagnostics).
voidsetOriginatingConstructType(int loc)
Set the type of creating expression (for use in diagnostics).
voidsetReceiver(SequenceReceiver receiver)
Change the Receiver to which output is written
voidsetTemporaryReceiver(SequenceReceiver out)
Set the output destination to write to a sequence.
booleanuseLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel)
Use local parameter.

Field Detail

caller

XPathContext caller

controller

Controller controller

currentIterator

SequenceIterator currentIterator

currentReceiver

SequenceReceiver currentReceiver

isTemporaryDestination

boolean isTemporaryDestination

last

int last

origin

Object origin

Constructor Detail

XPathContextMinor

protected XPathContextMinor()
Private Constructor

Method Detail

changeOutputDestination

public void changeOutputDestination(Properties props, Result result, boolean isFinal, int hostLanguage, 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: props properties defining the output format result Details of the new output destination isFinal true if the destination is a final result tree (either the principal output or a secondary result tree); false if hostLanguage

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

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 Comparator getCollation(String name)
Get a named collation

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: DynamicError if the context position is undefined

getController

public final Controller getController()
Get the Controller. May return null when running outside XSLT or XQuery

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

getCurrentTemplate

public Template getCurrentTemplate()
Get the current template. This is used to support xsl:apply-imports

Returns: the current template

getDefaultCollation

public final Comparator getDefaultCollation()
Get the default collation

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

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

getNamePool

public final NamePool getNamePool()
Get the Name Pool

getOrigin

public InstructionInfoProvider 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

getXSLTContext

public XPathContextMajor.XSLTContext getXSLTContext()
Get the XSLT-specific part of the context

isAtLast

public final boolean isAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last()

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

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(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.

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 XPathContextMinor 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

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 boolean useLocalParameter(int fingerprint, 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: fingerprint 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: true if a parameter of this name was supplied, false if not