Package net.sf.saxon.expr
Class EarlyEvaluationContext
java.lang.Object
net.sf.saxon.expr.EarlyEvaluationContext
- All Implemented Interfaces:
Serializable
,XPathContext
This class is an implementation of XPathContext used when evaluating constant sub-expressions at
compile time.
- See Also:
-
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 numberGet the calling XPathContext (the next one down the stack).getCollation
(String name) Get a named collationGet the ConfigurationGet the context itemint
Get the context position (the position of the context item)Get the Controller.Get the current group iterator.Get the current iterator.Get the current mode.Get the current regex iterator.Get the current template.Get the default collationint
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)Get the local (non-tunnel) parameters that were passed to the current function or templateGet a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriateGet the Name PoolGet information about the creating expression or other construct.int
Get the type of location from which this context was created.Get the Receiver to which output is currently being written.Get a reference to the local stack frame for variables.Get the tunnel parameters that were passed to the current function or template.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()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 receiver to which output is to be written, marking it as a temporary (non-final) output destination.boolean
useLocalParameter
(int fingerprint, LocalParam binding, boolean isTunnel) Use local parameter.
-
Constructor Details
-
EarlyEvaluationContext
-
-
Method Details
-
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.
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 if it is a temporary tree, xsl:attribute, etc.hostLanguage
-- 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
-
evaluateLocalVariable
Get the value of a local variable, identified by its slot number- Specified by:
evaluateLocalVariable
in interfaceXPathContext
-
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
-
getCollation
Get a named collation- Specified by:
getCollation
in interfaceXPathContext
- Throws:
XPathException
- if the collation is not recognized
-
getConfiguration
Get the Configuration- Specified by:
getConfiguration
in interfaceXPathContext
-
getContextItem
Get the context item- Specified by:
getContextItem
in interfaceXPathContext
- Returns:
- the context item, or null if the context item is 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
-
getController
Get the Controller. May return null when running outside XSLT or XQuery- Specified by:
getController
in interfaceXPathContext
-
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
-
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).
-
getCurrentMode
Get the current mode.- Specified by:
getCurrentMode
in interfaceXPathContext
- Returns:
- the current mode
-
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
-
getCurrentTemplateRule
Get the current template. This is used to support xsl:apply-imports- Specified by:
getCurrentTemplateRule
in interfaceXPathContext
- Returns:
- the current template
-
getDefaultCollation
Get the default collation- Specified by:
getDefaultCollation
in interfaceXPathContext
-
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
-
getLocalParameters
Get the local (non-tunnel) parameters that were passed to the current function or template- Specified by:
getLocalParameters
in interfaceXPathContext
- Returns:
- a ParameterSet containing the local parameters
-
getNamePool
Get the Name Pool- Specified by:
getNamePool
in interfaceXPathContext
-
getOrigin
Get information about the creating expression or other construct.- Specified by:
getOrigin
in interfaceXPathContext
-
getOriginatingConstructType
public int getOriginatingConstructType()Get the type of location from which this context was created.- Specified by:
getOriginatingConstructType
in interfaceXPathContext
-
getReceiver
Get the Receiver to which output is currently being written.- Specified by:
getReceiver
in interfaceXPathContext
- Returns:
- the current Receiver
-
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.
-
getTunnelParameters
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.- Specified by:
getTunnelParameters
in interfaceXPathContext
- Returns:
- a ParameterSet containing the tunnel parameters
-
getXSLTContext
Get the XSLT-specific part of the context- Specified by:
getXSLTContext
in interfaceXPathContext
-
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
-
newCleanContext
Construct a new context without copying (used for the context in a function call)- Specified by:
newCleanContext
in interfaceXPathContext
-
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
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
-
setCurrentIterator
Set a new sequence iterator.- Specified by:
setCurrentIterator
in interfaceXPathContext
-
setLocalVariable
Set the value of a local variable, identified by its slot number- Specified by:
setLocalVariable
in interfaceXPathContext
-
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
-
setReceiver
Change the Receiver to which output is written- Specified by:
setReceiver
in interfaceXPathContext
-
setTemporaryReceiver
Set the receiver to which output is to be written, marking it as a temporary (non-final) output destination.- Specified by:
setTemporaryReceiver
in interfaceXPathContext
- Parameters:
out
- The SequenceOutputter to be used
-
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
-
getImplicitTimezone
public int getImplicitTimezone()Get the implicit timezone, as a positive or negative offset from UTC in minutes. The range is -14hours to +14hours -
getNameChecker
Get a NameChecker for checking names against the XML 1.0 or XML 1.1 specification as appropriate
-