net.sf.saxon.xqj.Closable
net.sf.saxon.xqj.SaxonXQDynamicContext
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public abstract class SaxonXQDynamicContext
Saxon implementation of the XQJ DynamicContext interface
| Field Summary | |
|---|---|
protected SaxonXQConnection |
connection
|
| Constructor Summary | |
|---|---|
SaxonXQDynamicContext()
|
|
| Method Summary | |
|---|---|
void |
bindAtomicValue(QName varname,
String value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindBoolean(QName varname,
boolean value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindByte(QName varname,
byte value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindDocument(QName varname,
InputStream value,
String baseURI,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindDocument(QName varname,
Reader value,
String baseURI,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindDocument(QName varname,
Source value,
XQItemType type)
Binds a value to the given external variable or the context item from the given Source. |
void |
bindDocument(QName varname,
String value,
String baseURI,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindDocument(QName varname,
XMLStreamReader value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindDouble(QName varname,
double value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindFloat(QName varname,
float value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindInt(QName varname,
int value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindItem(QName varname,
XQItem value)
Binds a value to the given external variable. |
void |
bindLong(QName varname,
long value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindNode(QName varname,
Node value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindObject(QName varname,
Object value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindSequence(QName varname,
XQSequence value)
Binds a value to the given external variable or the context item. |
void |
bindShort(QName varname,
short value,
XQItemType type)
Binds a value to the given external variable or the context item. |
void |
bindString(QName varname,
String value,
XQItemType type)
Binds a value to the given external variable or the context item. |
protected abstract boolean |
externalVariableExists(QName name)
|
protected Configuration |
getConfiguration()
|
protected abstract SaxonXQDataFactory |
getDataFactory()
|
protected abstract DynamicQueryContext |
getDynamicContext()
|
TimeZone |
getImplicitTimeZone()
Gets the implicit timezone |
void |
setImplicitTimeZone(TimeZone implicitTimeZone)
Sets the implicit timezone |
| Methods inherited from class net.sf.saxon.xqj.Closable |
|---|
close, isClosed, setClosableContainer |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected SaxonXQConnection connection
| Constructor Detail |
|---|
public SaxonXQDynamicContext()
| Method Detail |
|---|
protected abstract DynamicQueryContext getDynamicContext()
protected final Configuration getConfiguration()
protected abstract SaxonXQDataFactory getDataFactory()
throws XQException
XQExceptionprotected abstract boolean externalVariableExists(QName name)
public void bindAtomicValue(QName varname,
String value,
XQItemType type)
throws XQException
XQDynamicContextxs: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 XQDynamicContextvarname - the name of the external variable to bind tovalue - the lexical string value of the typetype - 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 state
public void bindBoolean(QName varname,
boolean value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or during
query evaluation.
bindBoolean in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindByte(QName varname,
byte value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluation.
bindByte in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindDocument(QName varname,
InputStream value,
String baseURI,
XQItemType type)
throws XQException
XQDynamicContextnull,
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 XQDynamicContextvarname - the name of the external variable to bind to,
cannot be nullvalue - the value to be converted, cannot be
nullbaseURI - an optional base URI, can be null. It can
be used, for example, to resolve relative URIs and to
include in error messages.type - 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 state
public void bindDocument(QName varname,
Reader value,
String baseURI,
XQItemType type)
throws XQException
XQDynamicContextnull,
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 XQDynamicContextvarname - the name of the external variable to bind to,
cannot be nullvalue - the value to be converted, cannot be
nullbaseURI - an optional base URI, can be null. It can
be used, for example, to resolve relative URIs and to
include in error messages.type - 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 state
public void bindDocument(QName varname,
Source value,
XQItemType type)
throws XQException
XQDynamicContextSource. An XQJ
implementation must at least support the following implementations:
javax.xml.transform.dom.DOMSourcejavax.xml.transform.sax.SAXSourcejavax.xml.transform.stream.StreamSourcenull,
XQITEMKIND_DOCUMENT_ELEMENT, or
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
XQException
is raised either by this method, or during query evaluation.
bindDocument in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot
be nullvalue - the value to be converted, cannot be nulltype - 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 state
public void bindDocument(QName varname,
String value,
String baseURI,
XQItemType type)
throws XQException
XQDynamicContextnull,
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 XQDynamicContextvarname - the name of the external variable to bind to,
cannot be nullvalue - the value to be converted, cannot be
nullbaseURI - an optional base URI, can be null. It can
be used, for example, to resolve relative URIs and to
include in error messages.type - 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 state
public void bindDocument(QName varname,
XMLStreamReader value,
XQItemType type)
throws XQException
XQDynamicContextnull,
XQITEMKIND_DOCUMENT_ELEMENT or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
XQException is raised either by this method, or during
query evaluation.
bindDocument in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot
be nullvalue - the value to be converted, cannot be nulltype - 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 state
public void bindDouble(QName varname,
double value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluations.
bindDouble in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindFloat(QName varname,
float value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluations.
bindFloat in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindInt(QName varname,
int value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluations.
bindInt in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindItem(QName varname,
XQItem value)
throws XQException
XQDynamicContextXQItem. 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 XQDynamicContextvarname - the name of the external variable to bind to,
cannot be nullvalue - 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, (4) the expression is in a closed state,
or (5) the specified item is closed
public void bindLong(QName varname,
long value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluation.
bindLong in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindNode(QName varname,
Node value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluation.
bindNode in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be converted, cannot be nulltype - 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 state
public void bindObject(QName varname,
Object value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or during
query evaluation.
bindObject in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be converted, cannot be nulltype - 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 state
public void bindSequence(QName varname,
XQSequence value)
throws XQException
XQDynamicContextXQException is be raised either by this method, or
during query evaluation.
bindSequence in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - 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, (4) the expression is in a closed
state, or (5) the specified sequence is closed
public void bindShort(QName varname,
short value,
XQItemType type)
throws XQException
XQDynamicContextXQException is raised either by this method, or
during query evaluation.
bindShort in interface XQDynamicContextvarname - the name of the external variable to bind to, cannot be
nullvalue - the value to be convertedtype - 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 state
public void bindString(QName varname,
String value,
XQItemType type)
throws XQException
XQDynamicContextxs: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 XQDynamicContextvarname - the name of the external variable to bind to,
cannot be nullvalue - the value to be converted, cannot be
nulltype - 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 state
public TimeZone getImplicitTimeZone()
throws XQException
XQDynamicContext
getImplicitTimeZone in interface XQDynamicContextsetImplicitTimeZone method
or provided by the implementation
XQException - if the expression is in a closed state
public void setImplicitTimeZone(TimeZone implicitTimeZone)
throws XQException
XQDynamicContext
setImplicitTimeZone in interface XQDynamicContextimplicitTimeZone - time zone to be set
XQException - if the expression is in a closed state
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||