EarlyEvaluationContext
, XPathContextMajor
, XPathContextMinor
public interface XPathContext
Modifier and Type | Method | Description |
---|---|---|
void |
changeOutputDestination(java.util.Properties props,
javax.xml.transform.Result result,
boolean isFinal,
int hostLanguage,
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(java.lang.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
|
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.
|
StringCollator |
getDefaultCollation() |
Get the default collation
|
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().
|
java.util.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.
|
boolean |
useLocalParameter(StructuredQName qName,
LocalParam binding,
boolean isTunnel) |
Use local parameter.
|
XPathContextMajor newContext()
XPathContextMajor newCleanContext()
XPathContextMinor newMinorContext()
ParameterSet getLocalParameters()
ParameterSet getTunnelParameters()
void setOrigin(InstructionInfo expr)
Expression
, allowing information
about the calling instruction to be obtained.expr
- the expression that created this context objectvoid setOriginatingConstructType(int loc)
setOrigin(net.sf.saxon.trace.InstructionInfo)
should be called.loc
- The originating location: the argument must be one of the integer constants in class
Location
InstructionInfo getOrigin()
int getOriginatingConstructType()
Controller getController()
Configuration getConfiguration()
NamePool getNamePool()
void setCaller(XPathContext caller)
caller
- the XPathContext of the calling expressionXPathContext getCaller()
void setCurrentIterator(SequenceIterator iter)
iter
- the current iterator. The context item, position, and size are determined by reference
to the current iterator.SequenceIterator getCurrentIterator()
int getContextPosition() throws XPathException
XPathException
- if the context position is undefinedItem getContextItem()
int getLast() throws XPathException
XPathException
- if the context position is undefinedboolean isAtLast() throws XPathException
XPathException
StringCollator getCollation(java.lang.String name) throws XPathException
name
- the name (URI) of the required collationXPathException
- if the collation is not recognizedStringCollator getDefaultCollation()
boolean useLocalParameter(StructuredQName qName, LocalParam binding, boolean isTunnel) throws XPathException
qName
- The fingerprint of the parameter namebinding
- The XSLParam element to bind its value toisTunnel
- True if a tunnel parameter is required, else falseXPathException
StackFrame getStackFrame()
ValueRepresentation evaluateLocalVariable(int slotnumber)
slotnumber
- the slot number allocated at compile time to the variable,
which identifies its position within the local stack framevoid setLocalVariable(int slotnumber, ValueRepresentation value)
slotnumber
- the slot number allocated at compile time to the variable,
which identifies its position within the local stack framevalue
- the value of the variablevoid changeOutputDestination(java.util.Properties props, javax.xml.transform.Result result, boolean isFinal, int hostLanguage, int validation, SchemaType schemaType) throws XPathException
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 validatedXPathException
- 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 sequencevoid setTemporaryReceiver(SequenceReceiver out)
out
- The SequenceReceiver to be usedvoid setReceiver(SequenceReceiver receiver)
receiver
- the SequenceReceiver to be usedSequenceReceiver getReceiver()
Mode getCurrentMode()
Rule getCurrentTemplateRule()
GroupIterator getCurrentGroupIterator()
RegexIterator getCurrentRegexIterator()
DateTimeValue getCurrentDateTime() throws NoDynamicContextException
NoDynamicContextException
int getImplicitTimezone() throws NoDynamicContextException
NoDynamicContextException
java.util.Iterator iterateStackFrames()
ContextStackFrame
, starting with the top-most stackframe and
ending at the point the query or transformation was invoked by a calling application.