Package net.sf.saxon.query
Class DynamicQueryContext
- java.lang.Object
-
- net.sf.saxon.query.DynamicQueryContext
-
public class DynamicQueryContext extends java.lang.Object
This object represents a dynamic context for query execution. This class is used by the application writer to set up aspects of the dynamic context; it is not used operationally (or modified) by the XQuery processor itself, which copies all required information into its own internal representation.
-
-
Constructor Summary
Constructors Constructor Description DynamicQueryContext(Configuration config)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clearParameters()
Reset the parameters to an empty list.Configuration
getConfiguration()
Get the Configuration associated with this dynamic query contextItem
getContextItem()
Get the context item for the query, as set using setContextItem() or setContextNode().DateTimeValue
getCurrentDateTime()
Get the date and time set previously usingsetCurrentDateTime(net.sf.saxon.value.DateTimeValue)
or null if none has been set.javax.xml.transform.ErrorListener
getErrorListener()
Get the error listener.java.lang.Object
getParameter(java.lang.String expandedName)
Get the actual value of a parameter to the query.java.util.HashMap
getParameters()
Get all the supplied parameters as a HashMap.javax.xml.transform.URIResolver
getURIResolver()
Get the URI resolver.void
setContextItem(Item item)
Set the context item for evaluating the expression.void
setContextNode(NodeInfo node)
Deprecated.From Saxon 8.7, the methodsetContextItem(Item)
is preferredvoid
setCurrentDateTime(DateTimeValue dateTime)
Set a value to be used as the current date and time for the query.void
setErrorListener(javax.xml.transform.ErrorListener listener)
Set the error listener.void
setParameter(java.lang.String expandedName, java.lang.Object value)
Set a parameter for the query.void
setParameterValue(java.lang.String expandedName, ValueRepresentation value)
Set a parameter for the query.void
setURIResolver(javax.xml.transform.URIResolver resolver)
Set an object that will be used to resolve URIs used in fn:document() and related functions.
-
-
-
Constructor Detail
-
DynamicQueryContext
public DynamicQueryContext(Configuration config)
-
-
Method Detail
-
setContextNode
public void setContextNode(NodeInfo node)
Deprecated.From Saxon 8.7, the methodsetContextItem(Item)
is preferredSet the context item for evaluating the expression to be a node. If this method is not called, the context node will be undefined. The context node is available as the value of the expression ".". To obtain a NodeInfo by parsing a source document, see the methodbuildDocument
in class QueryProcessor.- Parameters:
node
- The node that is to be the context node for the query- Since:
- 8.4
-
setContextItem
public void setContextItem(Item item)
Set the context item for evaluating the expression. If this method is not called, the context node will be undefined. The context item is available as the value of the expression ".",. To obtain a node by parsing a source document, see the methodbuildDocument
in class QueryProcessor.- Parameters:
item
- The item that is to be the context item for the query- Since:
- 8.4
-
getContextItem
public Item getContextItem()
Get the context item for the query, as set using setContextItem() or setContextNode().- Returns:
- the context item if set, or null otherwise.
- Since:
- 8.4
-
setParameter
public void setParameter(java.lang.String expandedName, java.lang.Object value)
Set a parameter for the query.- Parameters:
expandedName
- The name of the parameter in "{uri}local-name" format. It is not an error to supply a value for a parameter that has not been declared, the parameter will simply be ignored. If the parameter has been declared in the query (as an external global variable) then it will be initialized with the value supplied.value
- The value of the parameter. This can be any valid Java object. It follows the same conversion rules as a value returned from a Saxon extension function. An error will occur at query execution time if the supplied value cannot be converted to the required type as declared in the query. For precise control of the type of the value, instantiate one of the classes in the net.sf.saxon.value package, for example net.sf.saxon.value.DayTimeDuration.- Since:
- 8.4
-
setParameterValue
public void setParameterValue(java.lang.String expandedName, ValueRepresentation value)
Set a parameter for the query.- Parameters:
expandedName
- The name of the parameter in "{uri}local-name" format. It is not an error to supply a value for a parameter that has not been declared, the parameter will simply be ignored. If the parameter has been declared in the query (as an external global variable) then it will be initialized with the value supplied.value
- The value of the parameter. This must be an XPath value in its Saxon representation: no conversion occurs.- Since:
- 8.8
-
clearParameters
public void clearParameters()
Reset the parameters to an empty list.
-
getParameter
public java.lang.Object getParameter(java.lang.String expandedName)
Get the actual value of a parameter to the query.- Parameters:
expandedName
- the name of the required parameter, in "{uri}local-name" format- Returns:
- the value of the parameter, if it exists, or null otherwise
-
getParameters
public java.util.HashMap getParameters()
Get all the supplied parameters as a HashMap. The key is the expanded QName in Clark notation, the value is the value as supplied to setParameterValue
-
setURIResolver
public void setURIResolver(javax.xml.transform.URIResolver resolver)
Set an object that will be used to resolve URIs used in fn:document() and related functions.- Parameters:
resolver
- An object that implements the URIResolver interface, or null.- Since:
- 8.4
-
getURIResolver
public javax.xml.transform.URIResolver getURIResolver()
Get the URI resolver.- Returns:
- the user-supplied URI resolver if there is one, or the system-defined one otherwise
- Since:
- 8.4
-
setErrorListener
public void setErrorListener(javax.xml.transform.ErrorListener listener)
Set the error listener. The error listener receives reports of all run-time errors and can decide how to report them.- Parameters:
listener
- the ErrorListener to be used- Since:
- 8.4
-
getErrorListener
public javax.xml.transform.ErrorListener getErrorListener()
Get the error listener.- Returns:
- the ErrorListener in use
- Since:
- 8.4
-
getCurrentDateTime
public DateTimeValue getCurrentDateTime()
Get the date and time set previously usingsetCurrentDateTime(net.sf.saxon.value.DateTimeValue)
or null if none has been set.- Returns:
- the current date and time, if it has been set.
- Since:
- 8.5
-
setCurrentDateTime
public void setCurrentDateTime(DateTimeValue dateTime) throws XPathException
Set a value to be used as the current date and time for the query. By default, the "real" current date and time are used. The main purpose of this method is that it allows repeatable results to be achieved when testing queries- Parameters:
dateTime
- The value to be used as the current date and time. This must include a timezone.- Throws:
XPathException
- Since:
- 8.5
-
getConfiguration
public Configuration getConfiguration()
Get the Configuration associated with this dynamic query context- Returns:
- the Configuration
- Since:
- 8.8
-
-