Package net.sf.saxon.expr
Class XPathContextMinor
java.lang.Object
net.sf.saxon.expr.XPathContextMinor
- All Implemented Interfaces:
XPathContext
- Direct Known Subclasses:
XPathContextMajor
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
FieldsModifier and TypeFieldDescription(package private) XPathContext
(package private) Controller
(package private) SequenceIterator
(package private) SequenceReceiver
(package private) boolean
(package private) int
(package private) Object
protected StackFrame
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
changeOutputDestination
(Properties props, Result result, boolean isFinal, int hostLanguage, int validation, SchemaType schemaType) Set a new output destination, supplying the output format details.evaluateLocalVariable
(int slotnumber) Get the value of a local variable, identified by its slot numberfinal XPathContext
Get the calling XPathContext (the next one down the stack).final Comparator
getCollation
(String name) Get a named collationfinal Configuration
Get the Configurationfinal Item
Get the context itemfinal int
Get the context position (the position of the context item)final Controller
Get the Controller.Get the current group iterator.final SequenceIterator
Get the current iterator.Get the current mode.Get the current regex iterator.Get the current template.final Comparator
Get the default collationfinal int
Get the implicit timezone, as a positive or negative offset from UTC in minutes.final int
getLast()
Get the context size (the position of the last item in the current node list)Get the local parameters for the current template call.final NameChecker
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriatefinal NamePool
Get the Name PoolGet information about the creating expression or other construct.int
Get the type of location from which this context was created.final SequenceReceiver
Get the Receiver to which output is currently being written.Get a reference to the local stack frame for variables.Get the tunnel parameters for the current template call.Get the XSLT-specific part of the contextfinal boolean
isAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last()Construct a new context without copying (used for the context in a function call)Construct a new context as a copy of another.Construct a new minor context.void
setCaller
(XPathContext caller) Set the calling XPathContextvoid
Set a new sequence iterator.void
setLocalVariable
(int slotnumber, ValueRepresentation value) Set the value of a local variable, identified by its slot numbervoid
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 writtenvoid
Set the output destination to write to a sequence.boolean
useLocalParameter
(int fingerprint, LocalParam binding, boolean isTunnel) Use local parameter.
-
Field Details
-
controller
Controller controller -
currentIterator
SequenceIterator currentIterator -
last
int last -
currentReceiver
SequenceReceiver currentReceiver -
isTemporaryDestination
boolean isTemporaryDestination -
caller
XPathContext caller -
stackFrame
-
origin
Object origin
-
-
Constructor Details
-
XPathContextMinor
protected XPathContextMinor()Private Constructor
-
-
Method Details
-
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- Specified by:
newContext
in interfaceXPathContext
-
newMinorContext
Description copied from interface:XPathContext
Construct a new minor context. A minor context can only hold new values of the focus (currentIterator) and current output destination.- Specified by:
newMinorContext
in interfaceXPathContext
-
setCaller
Set the calling XPathContext- Specified by:
setCaller
in interfaceXPathContext
-
newCleanContext
Construct a new context without copying (used for the context in a function call)- Specified by:
newCleanContext
in interfaceXPathContext
-
getXSLTContext
Get the XSLT-specific part of the context- Specified by:
getXSLTContext
in interfaceXPathContext
-
getLocalParameters
Get the local parameters for the current template call.- Specified by:
getLocalParameters
in interfaceXPathContext
- Returns:
- the supplied parameters
-
getTunnelParameters
Get the tunnel parameters for the current template call.- Specified by:
getTunnelParameters
in interfaceXPathContext
- Returns:
- the supplied tunnel parameters
-
setOrigin
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 anInstructionInfoProvider
, allowing information about the calling instruction to be obtained.- Specified by:
setOrigin
in interfaceXPathContext
-
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 orsetOrigin(net.sf.saxon.trace.InstructionInfoProvider)
should be called.- Specified by:
setOriginatingConstructType
in interfaceXPathContext
- Parameters:
loc
- The originating location: the argument must be one of the integer constants in classLocation
-
getOriginatingConstructType
public int getOriginatingConstructType()Get the type of location from which this context was created.- Specified by:
getOriginatingConstructType
in interfaceXPathContext
-
getOrigin
Get information about the creating expression or other construct.- Specified by:
getOrigin
in interfaceXPathContext
-
getController
Get the Controller. May return null when running outside XSLT or XQuery- Specified by:
getController
in interfaceXPathContext
-
getConfiguration
Get the Configuration- Specified by:
getConfiguration
in interfaceXPathContext
-
getNamePool
Get the Name Pool- Specified by:
getNamePool
in interfaceXPathContext
-
getNameChecker
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate -
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.- Specified by:
getCaller
in interfaceXPathContext
-
setCurrentIterator
Set a new sequence iterator.- Specified by:
setCurrentIterator
in interfaceXPathContext
-
getCurrentIterator
Get the current iterator. This encapsulates the context item, context position, and context size.- Specified by:
getCurrentIterator
in interfaceXPathContext
- Returns:
- the current iterator, or null if there is no current iterator (which means the context item, position, and size are undefined).
-
getContextPosition
Get the context position (the position of the context item)- Specified by:
getContextPosition
in interfaceXPathContext
- Returns:
- the context position (starting at one)
- Throws:
DynamicError
- if the context position is undefined
-
getContextItem
Get the context item- Specified by:
getContextItem
in interfaceXPathContext
- Returns:
- the context item, or null if the context item is undefined
-
getLast
Get the context size (the position of the last item in the current node list)- Specified by:
getLast
in interfaceXPathContext
- Returns:
- the context size
- Throws:
XPathException
- if the context position is undefined
-
isAtLast
Determine whether the context position is the same as the context size that is, whether position()=last()- Specified by:
isAtLast
in interfaceXPathContext
- Throws:
XPathException
-
getCollation
Get a named collation- Specified by:
getCollation
in interfaceXPathContext
- Throws:
XPathException
- if the collation is not recognized
-
getDefaultCollation
Get the default collation- Specified by:
getDefaultCollation
in interfaceXPathContext
-
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.- Specified by:
getStackFrame
in interfaceXPathContext
- Returns:
- array of variables.
-
evaluateLocalVariable
Get the value of a local variable, identified by its slot number- Specified by:
evaluateLocalVariable
in interfaceXPathContext
-
setLocalVariable
Set the value of a local variable, identified by its slot number- Specified by:
setLocalVariable
in interfaceXPathContext
-
changeOutputDestination
public void changeOutputDestination(Properties props, Result result, boolean isFinal, int hostLanguage, int validation, SchemaType schemaType) throws XPathException 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.- Specified by:
changeOutputDestination
in interfaceXPathContext
- Parameters:
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 ifhostLanguage
-- 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
-
setTemporaryReceiver
Set the output destination to write to a sequence.
This affects all further output until resetOutputDestination() is called.- Specified by:
setTemporaryReceiver
in interfaceXPathContext
- Parameters:
out
- The SequenceReceiver to be used
-
setReceiver
Change the Receiver to which output is written- Specified by:
setReceiver
in interfaceXPathContext
-
getReceiver
Get the Receiver to which output is currently being written.- Specified by:
getReceiver
in interfaceXPathContext
- Returns:
- the current Receiver
-
useLocalParameter
public boolean useLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel) throws XPathException 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- Specified by:
useLocalParameter
in interfaceXPathContext
- Parameters:
fingerprint
- The fingerprint of the parameter namebinding
- The XSLParam element to bind its value toisTunnel
- True if a tunnel parameter is required, else false- Returns:
- true if a parameter of this name was supplied, false if not
- Throws:
XPathException
-
getCurrentMode
Get the current mode.- Specified by:
getCurrentMode
in interfaceXPathContext
- Returns:
- the current mode
-
getCurrentTemplateRule
Get the current template. This is used to support xsl:apply-imports- Specified by:
getCurrentTemplateRule
in interfaceXPathContext
- Returns:
- the current template
-
getCurrentGroupIterator
Get the current group iterator. This supports the current-group() and current-grouping-key() functions in XSLT 2.0- Specified by:
getCurrentGroupIterator
in interfaceXPathContext
- Returns:
- the current grouped collection
-
getCurrentRegexIterator
Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0.- Specified by:
getCurrentRegexIterator
in interfaceXPathContext
- Returns:
- the current regular expressions iterator
-
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
-