| net.sf.saxon.expr.XPathContext
All known Subclasses: net.sf.saxon.expr.XPathContextMinor, net.sf.saxon.expr.EarlyEvaluationContext,
| XPathContext | | public interface XPathContext (Code) | | This class represents a context in which an XPath expression is evaluated.
|
| changeOutputDestination | | public void changeOutputDestination(Properties props, Result result, boolean isFinal, int validation, SchemaType schemaType) throws XPathException(Code) | | Set a new output destination, supplying the output format details.
Note that it is the caller's responsibility to close the Writer after use.
exception:
XPathException - if any dynamic error occurs; andspecifically, if an attempt is made to switch to a final outputdestination while writing a temporary tree or sequence
Parameters:
props - properties defining the output format
Parameters:
result - Details of the new output destination
Parameters:
isFinal - true if the destination is a final result tree(either the principal output or a secondary result tree); false ifit is a temporary tree, xsl:attribute, etc. |
| evaluateLocalVariable | | public ValueRepresentation evaluateLocalVariable(int slotnumber)(Code) | | Get the value of a local variable, identified by its slot number
|
| getCaller | | public XPathContext getCaller()(Code) | | 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.
|
| getContextItem | | public Item getContextItem()(Code) | | Get the context item
the context item, or null if the context item is undefined |
| getContextPosition | | public int getContextPosition() throws DynamicError(Code) | | Get the context position (the position of the context item)
the context position (starting at one)
throws:
DynamicError - if the context position is undefined |
| getController | | public Controller getController()(Code) | | Get the Controller. May return null when running outside XSLT or XQuery
|
| getCurrentGroupIterator | | public GroupIterator getCurrentGroupIterator()(Code) | | 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()(Code) | | 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()(Code) | | Get the current mode.
the current mode |
| getCurrentRegexIterator | | public RegexIterator getCurrentRegexIterator()(Code) | | Get the current regex iterator. This supports the functionality of the regex-group()
function in XSLT 2.0.
the current regular expressions iterator |
| getCurrentTemplate | | public Template getCurrentTemplate()(Code) | | Get the current template. This is used to support xsl:apply-imports
the current template |
| getDefaultCollation | | public Comparator getDefaultCollation()(Code) | | Get the default collation
|
| getLast | | public int getLast() throws XPathException(Code) | | Get the context size (the position of the last item in the current node list)
the context size
throws:
XPathException - if the context position is undefined |
| getLocalParameters | | public ParameterSet getLocalParameters()(Code) | | Get the local (non-tunnel) parameters that were passed to the current function or template
a ParameterSet containing the local parameters |
| getOriginatingConstructType | | public int getOriginatingConstructType()(Code) | | Get the type of location from which this context was created.
|
| getReceiver | | public SequenceReceiver getReceiver()(Code) | | Get the Receiver to which output is currently being written.
the current Receiver |
| getStackFrame | | public StackFrame getStackFrame()(Code) | | 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.
array of variables. |
| getTunnelParameters | | public ParameterSet getTunnelParameters()(Code) | | 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(Code) | | Determine whether the context position is the same as the context size
that is, whether position()=last()
|
| newCleanContext | | public XPathContextMajor newCleanContext()(Code) | | Construct a new context without copying (used for the context in a function call)
|
| newContext | | public XPathContextMajor newContext()(Code) | | 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()(Code) | | Construct a new minor context. A minor context can only hold new values of the focus
(currentIterator) and current output destination.
|
| setLocalVariable | | public void setLocalVariable(int slotnumber, ValueRepresentation value)(Code) | | Set the value of a local variable, identified by its slot number
|
| setOrigin | | public void setOrigin(InstructionInfoProvider expr)(Code) | | 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)(Code) | | Set the type of creating expression (for use in diagnostics). When a new context is created, either
this method or
XPathContext.setOrigin should be called.
Parameters:
loc - The originating location: the argument must be one of the integer constants in classnet.sf.saxon.trace.Location |
| setReceiver | | public void setReceiver(SequenceReceiver receiver)(Code) | | Change the Receiver to which output is written
|
| setTemporaryReceiver | | public void setTemporaryReceiver(SequenceReceiver out)(Code) | | Set the receiver to which output is to be written, marking it as a temporary (non-final)
output destination.
Parameters:
out - The SequenceOutputter to be used |
| useLocalParameter | | public boolean useLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel) throws XPathException(Code) | | 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
Parameters:
binding - The XSLParam element to bind its value to
Parameters:
isTunnel - True if a tunnel parameter is required, else false true if a parameter of this name was supplied, false if not |
|
|