net.sf.saxon.expr
public interface XPathContext
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 |
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 rule. |
int | getImplicitTimezone()
Get the implicit timezone |
int | 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 template |
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 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(). |
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 XPathContext |
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 SequenceReceiver to which output is written |
void | setTemporaryReceiver(SequenceReceiver out)
Set the SequenceReceiver to which output is to be written, marking it as a temporary (non-final)
output destination. |
int | useLocalParameter(StructuredQName qName, LocalParam binding, boolean isTunnel)
Use local parameter. |
Parameters: validation validation mode: strict, lax, preserve, or strip schemaType type against which the output must be validated
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 not
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.
Returns: the XPathContext of the calling expression
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
Returns: the Saxon configuration object
Returns: the context item, or null if the context item is undefined
Returns: the context position (starting at one)
Throws: XPathException if the context position is undefined
Returns: the controller for this query or transformation
Returns: the current date and time. All calls within a single query or transformation will return the same value
Returns: the current exception, or null if there is none defined
Returns: the current grouped collection
Returns: the current iterator, or null if there is no current iterator (which means the context item, position, and size are undefined).
Returns: the current mode
Returns: the current regular expressions iterator
Returns: the current template rule
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.
Returns: the context size
Throws: XPathException if the context position is undefined
Returns: a ParameterSet containing the local parameters
Returns: the name pool
Returns: information about the creating expression
Returns: 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)
Returns: the current SequenceReceiver
Returns: array of variables.
Returns: a ParameterSet containing the tunnel parameters
Returns: true if the context position is the same as the context size.
Returns: an iterator over a copy of the run-time call stack
Returns: a new clean context
Returns: a new context, created as a copy of this context
Returns: a new minor context
Parameters: caller the XPathContext of the calling expression
Parameters: iter the current iterator. The context item, position, and size are determined by reference to the current iterator.
Parameters: slotnumber the slot number allocated at compile time to the variable, which identifies its position within the local stack frame value the value of the variable
Parameters: expr the expression that created this context object
Parameters: loc The originating location: the argument must be one of the integer constants in class Location
Parameters: receiver the SequenceReceiver to be used
Parameters: out The SequenceReceiver to be used
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