|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.api.xqj.BXQPreparedExpression
public final class BXQPreparedExpression
Java XQuery API - Prepared Expression.
Constructor Summary | |
---|---|
BXQPreparedExpression(java.lang.String input,
BXQStaticContext s,
BXQConnection c)
Constructor. |
Method Summary | |
---|---|
void |
bindAtomicValue(javax.xml.namespace.QName qn,
java.lang.String v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindBoolean(javax.xml.namespace.QName qn,
boolean v,
XQItemType it)
Binds a value to the given external variable or the context item. |
void |
bindByte(javax.xml.namespace.QName qn,
byte v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindDocument(javax.xml.namespace.QName qn,
java.io.InputStream is,
java.lang.String base,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindDocument(javax.xml.namespace.QName qn,
java.io.Reader r,
java.lang.String base,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindDocument(javax.xml.namespace.QName qn,
javax.xml.transform.Source s,
XQItemType t)
Binds a value to the given external variable or the context item from the given Source . |
void |
bindDocument(javax.xml.namespace.QName qn,
java.lang.String v,
java.lang.String base,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindDocument(javax.xml.namespace.QName qn,
org.xml.sax.XMLReader r,
XQItemType t)
Binds a value to the given external variable. |
void |
bindDocument(javax.xml.namespace.QName qn,
javax.xml.stream.XMLStreamReader sr,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindDouble(javax.xml.namespace.QName qn,
double v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindFloat(javax.xml.namespace.QName qn,
float v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindInt(javax.xml.namespace.QName qn,
int v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindItem(javax.xml.namespace.QName qn,
XQItem t)
Binds a value to the given external variable. |
void |
bindLong(javax.xml.namespace.QName qn,
long v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindNode(javax.xml.namespace.QName qn,
org.w3c.dom.Node n,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindObject(javax.xml.namespace.QName qn,
java.lang.Object v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindSequence(javax.xml.namespace.QName qn,
XQSequence s)
Binds a value to the given external variable or the context item. |
void |
bindShort(javax.xml.namespace.QName qn,
short v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
bindString(javax.xml.namespace.QName qn,
java.lang.String v,
XQItemType t)
Binds a value to the given external variable or the context item. |
void |
cancel()
Attempts to cancel the execution if both the XQuery engine and XQJ driver support aborting the execution of an XQPreparedExpression . |
void |
close()
Closes the class. |
XQResultSequence |
executeQuery()
Executes the prepared query expression. |
javax.xml.namespace.QName[] |
getAllExternalVariables()
Retrieves all the external variables defined in the prolog of the prepared expression. |
javax.xml.namespace.QName[] |
getAllUnboundExternalVariables()
Retrieves the names of all unbound external variables. |
java.util.TimeZone |
getImplicitTimeZone()
Gets the implicit timezone |
XQStaticContext |
getStaticContext()
Gets an XQStaticContext representing the values for all
expression properties. |
XQSequenceType |
getStaticResultType()
Gets the static type information of the result sequence. |
XQSequenceType |
getStaticVariableType(javax.xml.namespace.QName qn)
Retrieves the static type of a given external variable. |
boolean |
isClosed()
Returns the closed flag. |
void |
setImplicitTimeZone(java.util.TimeZone tz)
Sets the implicit timezone |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.xml.xquery.XQPreparedExpression |
---|
close, isClosed |
Methods inherited from interface javax.xml.xquery.XQDynamicContext |
---|
bindAtomicValue, bindBoolean, bindByte, bindDocument, bindDocument, bindDocument, bindDocument, bindDocument, bindDocument, bindDouble, bindFloat, bindInt, bindItem, bindLong, bindNode, bindObject, bindSequence, bindShort, bindString, getImplicitTimeZone, setImplicitTimeZone |
Constructor Detail |
---|
public BXQPreparedExpression(java.lang.String input, BXQStaticContext s, BXQConnection c) throws XQQueryException
input
- query instances
- static contextc
- closer
XQQueryException
- exceptionMethod Detail |
---|
public void cancel() throws XQException
XQPreparedExpression
XQPreparedExpression
.
This method can be used by one thread to cancel an XQPreparedExpression
,
that is being executed in another thread. If cancellation is not supported or
the attempt to cancel the execution was not successful, the method returns without
any error. If the cancellation is successful, an XQException
is thrown, to indicate that it has been aborted, by executeQuery
,
executeCommand
or any method accessing the XQResultSequence
returned by executeQuery
. If applicable, any open XQResultSequence
and XQResultItem
objects will also be implicitly closed in this case.
cancel
in interface XQPreparedExpression
XQException
- if the prepared expression is in a closed statepublic XQResultSequence executeQuery() throws XQException
XQPreparedExpression
executeQuery
in interface XQPreparedExpression
XQException
- if (1) there are errors when executing the prepared
expression, (2) the prepared expression is in a closed state,
or (3) the query execution is cancelledpublic javax.xml.namespace.QName[] getAllExternalVariables() throws XQException
XQPreparedExpression
getAllExternalVariables
in interface XQPreparedExpression
QName
objects for all the external
variables defined in the prolog of a prepared expression.
Empty array if there are no external variables present.
XQException
- if the prepared expression is in a closed statepublic javax.xml.namespace.QName[] getAllUnboundExternalVariables() throws XQException
XQPreparedExpression
getAllUnboundExternalVariables
in interface XQPreparedExpression
QName
for all the external variables defined
in the prolog of a prepared expression that are yet to be bound
with a value. If there are no such variables an empty array
is returned
XQException
- if the prepared expression is in a closed statepublic XQStaticContext getStaticContext() throws XQException
XQPreparedExpression
XQStaticContext
representing the values for all
expression properties. Note that these properties cannot be changed; in
order to change, a new XQPreparedExpression
needs to be created.
getStaticContext
in interface XQPreparedExpression
XQStaticContext
representing
the values for all expression properties
XQException
- if the expression is in a closed statepublic XQSequenceType getStaticResultType() throws XQException
XQPreparedExpression
XQSequenceType
object
corresponding to the XQuery sequence type item()*
.
getStaticResultType
in interface XQPreparedExpression
XQSequenceType
containing the static
result information.
XQException
- if the prepared expression is in a closed statepublic XQSequenceType getStaticVariableType(javax.xml.namespace.QName qn) throws XQException
XQPreparedExpression
getStaticVariableType
in interface XQPreparedExpression
qn
- the name of the external variable
XQException
- if (1) the variable does not exist in the static
context of the expression, or (2) the sequence is
in a closed state, or (3) the name
parameter is null
public void bindAtomicValue(javax.xml.namespace.QName qn, java.lang.String v, XQItemType t) throws XQException
XQDynamicContext
xs:string
rules outlined in
17.1.1 Casting from xs:string and xs:untypedAtomic, XQuery 1.0 and
XPath 2.0 Functions and Operators.
If the cast fails, or if there is a mismatch between the static and
dynamic types, an XQException
is thrown either by this
method or during query evaluation.
bindAtomicValue
in interface XQDynamicContext
qn
- the name of the external variable to bind tov
- the lexical string value of the typet
- the item type of the bind
XQException
- if (1) any of the arguments are null
,
(2) given type is not an atomic type,
(3) the conversion of the value to an XDM instance failed,
(4) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable,
(5) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (6) the expression is in a closed statepublic void bindBoolean(javax.xml.namespace.QName qn, boolean v, XQItemType it) throws XQException
XQDynamicContext
XQException
is raised either by this method, or during
query evaluation.
bindBoolean
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedit
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindByte(javax.xml.namespace.QName qn, byte v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluation.
bindByte
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDocument(javax.xml.namespace.QName qn, java.io.InputStream is, java.lang.String base, XQItemType t) throws XQException
XQDynamicContext
null
,
XQITEMKIND_DOCUMENT_ELEMENT
, or
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
XQException
is raised either by this
method, or during query evaluation. If the value is not well formed,
or if a kind of the input type other than the values list above is
specified, behavior is implementation defined and may raise an exception.
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
is
- the value to be converted, cannot be
null
base
- an optional base URI, can be null
. It can
be used, for example, to resolve relative URIs and to
include in error messages.t
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value
argument is null
, (2) the
conversion of the value to an XDM instance failed,
(3) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable, (4) in case of an
XQPreparedExpression
, the variable is not
defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDocument(javax.xml.namespace.QName qn, java.io.Reader r, java.lang.String base, XQItemType t) throws XQException
XQDynamicContext
null
,
XQITEMKIND_DOCUMENT_ELEMENT
, or
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
XQException
is raised either by this
method, or during query evaluation. If the value is not well formed,
or if a kind of the input type other than the values list above is
specified, behavior is implementation defined and may raise an exception.
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
r
- the value to be converted, cannot be
null
base
- an optional base URI, can be null
. It can
be used, for example, to resolve relative URIs and to
include in error messages.t
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value
argument is null
, (2) the
conversion of the value to an XDM instance failed,
(3) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable, (4) in case of an
XQPreparedExpression
, the variable is not
defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDocument(javax.xml.namespace.QName qn, javax.xml.transform.Source s, XQItemType t) throws XQException
XQDynamicContext
Source
. An XQJ
implementation must at least support the following implementations:
javax.xml.transform.dom.DOMSource
javax.xml.transform.sax.SAXSource
javax.xml.transform.stream.StreamSource
null
,
XQITEMKIND_DOCUMENT_ELEMENT
, or
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
XQException
is raised either by this method, or during query evaluation.
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot
be null
s
- the value to be converted, cannot be null
t
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value
argument is null
, (2) the
conversion of the value to an XDM instance failed,
(3) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable, (4) in case of an
XQPreparedExpression
, the variable is not
defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDocument(javax.xml.namespace.QName qn, java.lang.String v, java.lang.String base, XQItemType t) throws XQException
XQDynamicContext
null
,
XQITEMKIND_DOCUMENT_ELEMENT
, or
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
XQException
is raised either by this
method, or during query evaluation. If the value is not well formed,
or if a kind of the input type other than the values list above is
specified, behavior is implementation defined and may raise an exception.
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
v
- the value to be converted, cannot be
null
base
- an optional base URI, can be null
. It can
be used, for example, to resolve relative URIs and to
include in error messages.t
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value
argument is null
, (2) the
conversion of the value to an XDM instance failed,
(3) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable, (4) in case of an
XQPreparedExpression
, the variable is not
defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDocument(javax.xml.namespace.QName qn, org.xml.sax.XMLReader r, XQItemType t) throws XQException
XQDynamicContext
XMLReader
produces a well-formed XML document, it results in a
document node. The kind of the input type must be null
,
XQITEMKIND_DOCUMENT_ELEMENT
or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
ContentHandler
is passed to the XML
XMLReader
; and optionally an implementation can specify additional
handlers like a LexicalHandler
. Subsequently
parse(String systemId)
will be invoked; and as such the
XMLReader
will pass the SAX event representing the document
to bind. The systemId
argument identifies the external
variable, a QName
formatted into a String
using
the James Clark representation.
XQConnection
connection...
... // Create an XMLReader, which will pass the SAX events to the XQJ // implementation XMLFilter xmlReader = new XMLFilterImpl() { public void parse(String systemId) throws IOException, SAXException { // foo.xml is the XML document to bind super.parse("foo.xml"); } }; // The parent XML Reader is a SAX parser, which will do the // actual work of parsing the XML document xmlReader.setParent(org.xml.sax.helpers.XMLReaderFactory.createXMLReader()); // Create an XQPreparedExpression XQPreparedExpression e = connection.prepareExpression("declare variable $doc as document-node(element(*, xs:untyped)) external; $doc//foo)); e.bindDocument(new QName("doc"), xmlReader); XQResultSequence result = preparedExpression.executeQuery(); result.writeSequence(System.out); ...
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
r
- the XMLReader
producing SAX events
representing the document to bindt
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value argument
is null
, (2) the conversion of the
value to an XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type
of the bound value is not compatible with the static
type of the variable, (4) in case of an
XQPreparedExpression
, the variable is
not defined in the prolog of the expression, (5)
if the expression is in a closed state, or (6) the
XMLReader
reports an error during
parse()
public void bindDocument(javax.xml.namespace.QName qn, javax.xml.stream.XMLStreamReader sr, XQItemType t) throws XQException
XQDynamicContext
null
,
XQITEMKIND_DOCUMENT_ELEMENT
or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
.
XQException
is raised either by this method, or during
query evaluation.
bindDocument
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot
be null
sr
- the value to be converted, cannot be null
t
- the type of the value for the created
document node. If null
is specified,
it behaves as if
XQDataFactory.createDocumentElementType(
XQDataFactory.createElementType(null,
XQItemType.XQBASETYPE_XS_UNTYPED))
were passed in
as the type parameter. That is, the type represents the
XQuery sequence type document-node(element(*, xs:untyped))
XQException
- if (1) the varName
or value
argument is null
, (2) the
conversion of the value to an XDM instance failed,
(3) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable, (4) in case of an
XQPreparedExpression
, the variable is not
defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindDouble(javax.xml.namespace.QName qn, double v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluations.
bindDouble
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindFloat(javax.xml.namespace.QName qn, float v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluations.
bindFloat
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindInt(javax.xml.namespace.QName qn, int v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluations.
bindInt
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindItem(javax.xml.namespace.QName qn, XQItem t) throws XQException
XQDynamicContext
XQItem
. In case of a mismatch
between the static and dynamic types, an XQException
is
raised either by this method, or during query evaluation.
bindItem
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
t
- the value to be bound, cannot be null
XQException
- if (1) any of the arguments are null
,
(2) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable,
(3) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the
expression, or (4) the expression is in a closed statepublic void bindLong(javax.xml.namespace.QName qn, long v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluation.
bindLong
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindNode(javax.xml.namespace.QName qn, org.w3c.dom.Node n, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluation.
bindNode
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
n
- the value to be converted, cannot be null
t
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
or value
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindObject(javax.xml.namespace.QName qn, java.lang.Object v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or during
query evaluation.
bindObject
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be converted, cannot be null
t
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
or value
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindSequence(javax.xml.namespace.QName qn, XQSequence s) throws XQException
XQDynamicContext
XQException
is be raised either by this method, or
during query evaluation.
bindSequence
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
s
- the value to be bound, cannot be null
XQException
- if (1) any of the arguments are null
,
(2) in case of an XQPreparedExpression
,
the dynamic type of the bound value is not compatible
with the static type of the variable,
(3) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of
the expression, or (4) the expression is in a closed
statepublic void bindShort(javax.xml.namespace.QName qn, short v, XQItemType t) throws XQException
XQDynamicContext
XQException
is raised either by this method, or
during query evaluation.
bindShort
in interface XQDynamicContext
qn
- the name of the external variable to bind to, cannot be
null
v
- the value to be convertedt
- the type of the value to be bound to the external variable.
The default type of the value is used in case null
is specified
XQException
- if (1) the varName
argument
is null
, (2) the conversion of the value to an
XDM instance failed, (3) in case of an
XQPreparedExpression
, the dynamic type of the bound
value is not compatible with the static type of the variable,
(4) in case of an XQPreparedExpression
,
the variable is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic void bindString(javax.xml.namespace.QName qn, java.lang.String v, XQItemType t) throws XQException
XQDynamicContext
xs:string
or a type derived by restriction
from xs:string
. If the specified type is null
,
it defaults to xs:string
.XQException
is raised either by this
method, or during query evaluation.
bindString
in interface XQDynamicContext
qn
- the name of the external variable to bind to,
cannot be null
v
- the value to be converted, cannot be
null
t
- the type of the value to be bound to the
external variable. The default type,
xs:string
, is used in case
null
is specified
XQException
- if (1) the varName
or
value
argument is null
,
(2) the conversion of the value to an XDM
instance failed, (3) in case of an
XQPreparedExpression
, the dynamic
type of the bound value is not compatible with the
static type of the variable, (4) in case of an
XQPreparedExpression
, the variable
is not defined in the prolog of the expression,
or (5) if the expression is in a closed statepublic java.util.TimeZone getImplicitTimeZone() throws XQException
XQDynamicContext
getImplicitTimeZone
in interface XQDynamicContext
setImplicitTimeZone
method
or provided by the implementation
XQException
- if the expression is in a closed statepublic void setImplicitTimeZone(java.util.TimeZone tz) throws XQException
XQDynamicContext
setImplicitTimeZone
in interface XQDynamicContext
tz
- time zone to be set
XQException
- if the expression is in a closed statepublic final void close()
public final boolean isClosed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |