Package net.sf.saxon.expr
Class XPathContextMinor
- java.lang.Object
-
- net.sf.saxon.expr.XPathContextMinor
-
- All Implemented Interfaces:
XPathContext
- Direct Known Subclasses:
XPathContextMajor
public class XPathContextMinor extends java.lang.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
Fields Modifier and Type Field Description (package private) XPathContext
caller
(package private) Controller
controller
(package private) SequenceIterator
currentIterator
(package private) SequenceReceiver
currentReceiver
(package private) boolean
isTemporaryDestination
(package private) int
last
(package private) java.lang.Object
origin
protected StackFrame
stackFrame
-
Constructor Summary
Constructors Modifier Constructor Description protected
XPathContextMinor()
Private Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods 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 numberXPathContext
getCaller()
Get the calling XPathContext (the next one down the stack).java.util.Comparator
getCollation(java.lang.String name)
Get a named collationConfiguration
getConfiguration()
Get the ConfigurationItem
getContextItem()
Get the context itemint
getContextPosition()
Get the context position (the position of the context item)Controller
getController()
Get the Controller.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.java.util.Comparator
getDefaultCollation()
Get the default collationint
getImplicitTimezone()
Get the implicit timezone, as a positive or negative offset from UTC in minutes.int
getLast()
Get the context size (the position of the last item in the current node list)ParameterSet
getLocalParameters()
Get the local parameters for the current template call.NameChecker
getNameChecker()
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriateNamePool
getNamePool()
Get the Name PoolInstructionInfoProvider
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 for the current template call.XPathContextMajor.XSLTContext
getXSLTContext()
Get the XSLT-specific part of the contextboolean
isAtLast()
Determine whether the context position is the same as the context size that is, whether position()=last()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 XPathContextvoid
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 numbervoid
setOrigin(InstructionInfoProvider 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 Receiver to which output is writtenvoid
setTemporaryReceiver(SequenceReceiver out)
Set the output destination to write to a sequence.boolean
useLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel)
Use local parameter.
-
-
-
Field Detail
-
controller
Controller controller
-
currentIterator
SequenceIterator currentIterator
-
last
int last
-
currentReceiver
SequenceReceiver currentReceiver
-
isTemporaryDestination
boolean isTemporaryDestination
-
caller
XPathContext caller
-
stackFrame
protected StackFrame stackFrame
-
origin
java.lang.Object origin
-
-
Method Detail
-
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- Specified by:
newContext
in interfaceXPathContext
-
newMinorContext
public XPathContextMinor 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
public void setCaller(XPathContext caller)
Set the calling XPathContext- Specified by:
setCaller
in interfaceXPathContext
-
newCleanContext
public XPathContextMajor newCleanContext()
Construct a new context without copying (used for the context in a function call)- Specified by:
newCleanContext
in interfaceXPathContext
-
getXSLTContext
public XPathContextMajor.XSLTContext getXSLTContext()
Get the XSLT-specific part of the context- Specified by:
getXSLTContext
in interfaceXPathContext
-
getLocalParameters
public ParameterSet getLocalParameters()
Get the local parameters for the current template call.- Specified by:
getLocalParameters
in interfaceXPathContext
- Returns:
- the supplied parameters
-
getTunnelParameters
public ParameterSet getTunnelParameters()
Get the tunnel parameters for the current template call.- Specified by:
getTunnelParameters
in interfaceXPathContext
- Returns:
- the supplied tunnel parameters
-
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 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
public InstructionInfoProvider getOrigin()
Get information about the creating expression or other construct.- Specified by:
getOrigin
in interfaceXPathContext
-
getController
public final Controller getController()
Get the Controller. May return null when running outside XSLT or XQuery- Specified by:
getController
in interfaceXPathContext
-
getConfiguration
public final Configuration getConfiguration()
Get the Configuration- Specified by:
getConfiguration
in interfaceXPathContext
-
getNamePool
public final NamePool getNamePool()
Get the Name Pool- Specified by:
getNamePool
in interfaceXPathContext
-
getNameChecker
public final NameChecker getNameChecker()
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate
-
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.- Specified by:
getCaller
in interfaceXPathContext
-
setCurrentIterator
public void setCurrentIterator(SequenceIterator iter)
Set a new sequence iterator.- Specified by:
setCurrentIterator
in interfaceXPathContext
-
getCurrentIterator
public final SequenceIterator 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
public final int getContextPosition() throws DynamicError
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
public final Item getContextItem()
Get the context item- Specified by:
getContextItem
in interfaceXPathContext
- Returns:
- the context item, or null if the context item is undefined
-
getLast
public final int getLast() throws XPathException
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
public final boolean isAtLast() throws XPathException
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
public final java.util.Comparator getCollation(java.lang.String name) throws XPathException
Get a named collation- Specified by:
getCollation
in interfaceXPathContext
- Throws:
XPathException
- if the collation is not recognized
-
getDefaultCollation
public final java.util.Comparator getDefaultCollation()
Get the default collation- Specified by:
getDefaultCollation
in interfaceXPathContext
-
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.- Specified by:
getStackFrame
in interfaceXPathContext
- Returns:
- array of variables.
-
evaluateLocalVariable
public ValueRepresentation evaluateLocalVariable(int slotnumber)
Get the value of a local variable, identified by its slot number- Specified by:
evaluateLocalVariable
in interfaceXPathContext
-
setLocalVariable
public void setLocalVariable(int slotnumber, ValueRepresentation value)
Set the value of a local variable, identified by its slot number- Specified by:
setLocalVariable
in interfaceXPathContext
-
changeOutputDestination
public void changeOutputDestination(java.util.Properties props, javax.xml.transform.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
public void setTemporaryReceiver(SequenceReceiver out)
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
public void setReceiver(SequenceReceiver receiver)
Change the Receiver to which output is written- Specified by:
setReceiver
in interfaceXPathContext
-
getReceiver
public final SequenceReceiver 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
public Mode getCurrentMode()
Get the current mode.- Specified by:
getCurrentMode
in interfaceXPathContext
- Returns:
- the current mode
-
getCurrentTemplateRule
public Rule getCurrentTemplateRule()
Get the current template. This is used to support xsl:apply-imports- Specified by:
getCurrentTemplateRule
in interfaceXPathContext
- Returns:
- the current template
-
getCurrentGroupIterator
public GroupIterator 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
public RegexIterator 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
-
-