|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.xqj.Closable net.sf.saxon.xqj.SaxonXQDataFactory net.sf.saxon.xqj.SaxonXQConnection
public class SaxonXQConnection
Saxon implementation of the XQL interface XQConnection. This interface represents a "connection" between an XQuery application and an XQuery server. In Saxon the client and server run in the same process so the concept of a connection is rather notional, and some of the properties have little meaning. However, the connection is the factory object used to compile queries.
For Javadoc descriptions of the public methors, see the XQJ documentation.
Method Summary | |
---|---|
void |
commit()
Makes all changes made in the current transaction permanent and releases any locks held by the datasource. |
XQPreparedExpression |
copyPreparedExpression(XQPreparedExpression expression)
Copy a prepared expression to create a new prepared expression. |
XQExpression |
createExpression()
Creates a new XQExpression object that can be used
to perform execute immediate operations with XQuery expressions. |
XQExpression |
createExpression(XQStaticContext properties)
Creates a new XQExpression object that can be used to
perform execute immediate operations with XQuery expressions. |
boolean |
getAutoCommit()
Gets the auto-commit attribute of this connection |
Configuration |
getConfiguration()
Get the Saxon Configuration in use. |
XQMetaData |
getMetaData()
Gets the metadata for this connection. |
XQStaticContext |
getStaticContext()
Gets an XQStaticContext representing the default values for
all expression properties. |
XQPreparedExpression |
prepareExpression(InputStream xquery)
Prepares an expression for execution. |
XQPreparedExpression |
prepareExpression(InputStream xquery,
XQStaticContext properties)
Prepares an expression for execution. |
XQPreparedExpression |
prepareExpression(Reader xquery)
Prepares an expression for execution. |
XQPreparedExpression |
prepareExpression(Reader xquery,
XQStaticContext properties)
Prepares an expression for execution. |
XQPreparedExpression |
prepareExpression(String xquery)
Prepares an expression for execution. |
XQPreparedExpression |
prepareExpression(String xquery,
XQStaticContext properties)
Prepares an expression for execution. |
void |
rollback()
Undoes all changes made in the current transaction and releases any locks held by the datasource. |
void |
setAutoCommit(boolean autoCommit)
Sets the auto-commit attribute to the given state. |
void |
setStaticContext(XQStaticContext properties)
Sets the default values for all expression properties. |
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 |
Methods inherited from interface javax.xml.xquery.XQConnection |
---|
close, isClosed |
Method Detail |
---|
public Configuration getConfiguration()
public void commit() throws XQException
XQConnection
XQResultSequence
, or XQResultItem
may be
implicitly closed upon commit, if the holdability property of the
sequence is set to XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT
.
commit
in interface XQConnection
XQException
- if the connection is in a closed state
or this connection is operating in auto-commit modepublic XQExpression createExpression() throws XQException
XQConnection
XQExpression
object that can be used
to perform execute immediate operations with XQuery expressions.
The properties of the connection's default XQStaticContext
are
copied to the returned XQExpression
.
createExpression
in interface XQConnection
XQExpression
that can be used to execute
multiple expressions
XQException
- if the connection is in a closed statepublic XQExpression createExpression(XQStaticContext properties) throws XQException
XQConnection
XQExpression
object that can be used to
perform execute immediate operations with XQuery expressions. The
properties of the specified XQStaticContext
values are
copied to the returned XQExpression
.
createExpression
in interface XQConnection
properties
- XQStaticContext
containing
values of expression properties
XQExpression
that can be used to execute
multiple expressions
XQException
- if (1) the connection is in a closed state, or
(2) the specified argument is null
public boolean getAutoCommit() throws XQException
XQConnection
getAutoCommit
in interface XQConnection
true
if the connection operates
in auto-commit mode; otherwise false
XQException
- if the connection is in a closed statepublic XQMetaData getMetaData() throws XQException
XQConnection
getMetaData
in interface XQConnection
XQMetadata
representing the metadata of
this connection
XQException
- if the connection is in a closed statepublic XQStaticContext getStaticContext() throws XQException
XQConnection
XQStaticContext
representing the default values for
all expression properties. In order to modify the defaults, it is not
sufficient to modify the values in the returned
XQStaticContext
object; in addition
setStaticContext
should be called to make those new values
effective.
getStaticContext
in interface XQConnection
XQStaticContext
representing the
default values for all expression properties
XQException
- if the connection is in a closed statepublic XQPreparedExpression prepareExpression(InputStream xquery) throws XQException
XQConnection
The properties of the connection's default XQStaticContext
are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as an InputStream
.
Cannot be null
XQException
- if (1) the connection is in a closed state,
(2) there are errors preparing the expression
or (3) the xquery parameter is null
public XQPreparedExpression prepareExpression(InputStream xquery, XQStaticContext properties) throws XQException
XQConnection
The properties of the specified XQStaticContext
values are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as an InputStream
.
Cannot be null
properties
- XQStaticContext
containing
values of expression properties
XQException
- if (1) the connection is in a closed state, or
(2) the specified argument is null
public XQPreparedExpression prepareExpression(Reader xquery) throws XQException
XQConnection
The properties of the connection's default XQStaticContext
are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as a Reader
.
Cannot be null
XQException
- if (1) the connection is in a closed state,
(2) there are errors preparing the expression,
or (3) the xquery parameter is null
public XQPreparedExpression prepareExpression(Reader xquery, XQStaticContext properties) throws XQException
XQConnection
The properties of the specified XQStaticContext
values are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as a Reader
.
Cannot be null
properties
- XQStaticContext
containing
values of expression properties
XQException
- if (1) the connection is in a closed state, or
(2) the specified argument is null
public XQPreparedExpression prepareExpression(String xquery) throws XQException
XQConnection
The properties of the connection's default XQStaticContext
are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as a String
.
Cannot be null
XQException
- if (1) the connection is in a closed state,
(2) there are errors preparing the expression,
or (3) the xquery parameter is null
public XQPreparedExpression prepareExpression(String xquery, XQStaticContext properties) throws XQException
XQConnection
The properties of the specified XQStaticContext
values are
copied to the returned XQPreparedExpression
.
prepareExpression
in interface XQConnection
xquery
- the XQuery expression as a String
.
Cannot be null
properties
- XQStaticContext
containing
values of expression properties.
XQException
- if (1) the connection is in a closed state, or
(2) the specified argument is null
public XQPreparedExpression copyPreparedExpression(XQPreparedExpression expression) throws XQException
expression
- the XQPreparedExpression to be copied. This must have been created using Saxon, and it
must have been created with an XQConnection derived from the same XQDataSource as this connection.
XQException,
- for example if either of the connections has been closed
XQException
public void rollback() throws XQException
XQConnection
rollback
in interface XQConnection
XQException
- if the connection is in a closed state
or this connection is operating
in auto-commit modepublic void setAutoCommit(boolean autoCommit) throws XQException
XQConnection
commit()
or rollback()
.setAutoCommit
is called and the auto-commit attribute is not changed from its
current value, the request is treated as a no-op.
setAutoCommit
in interface XQConnection
autoCommit
- true
to enable auto-commit mode;
false
to disable it
XQException
- if (1) the connection is in a closed state,
or (2) auto-commit is turned off but the
implementation doesn't support transactionspublic void setStaticContext(XQStaticContext properties) throws XQException
XQConnection
XQStaticContext
and update its private copy.
setStaticContext
in interface XQConnection
properties
- XQStaticContext
containing
values of expression properties
XQException
- if the connection is in a closed state
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |