net.axyana.qizxopen.xquery
Class XQueryConnection

java.lang.Object
  net.axyana.qizxopen.xquery.XQueryEnvironment
      net.axyana.qizxopen.xquery.XQueryConnection

All Implemented Interfaces:

java.io.Serializable

public class XQueryConnection

extends XQueryEnvironment

XQueryConnection is the main interface for XQuery applications. It represents an access to the resources managed by a XQuery engine:

Connections created from a XQuery engine share a Module Manager for accessing and caching XQuery modules. They share parsed XML documents through a Document Manager (DocumentManager) which accesses and caches the documents.

A XQueryConnection provides an environment allowing to:

• Create and compile XQuery Expressions (Static Environment).

  Each connection may define some particular settings, like namespace prefixes, default namespaces, base URI, predefined global variables.

• Define options and resources for the execution of Expressions (Dynamic Environment). This includes: default collation, implicit timezone, default output for serialization, default document or collection input (XQuery function input).

Caution: XQueryConnection is not thread-safe: only one thread is supposed to handle a XQueryConnection at a time.

See Also:

Serialized Form

Field Summary

Fields inherited from class net.axyana.qizxopen.xquery.XQueryEnvironment

DOC_BASE_URI, EXEC_TIMEOUT, MODULE_BASE_URI, SOURCE_URI, TRACE_EXECUTION, TRACE_QUERY_COMPIL

Constructor Summary

XQueryConnection(net.axyana.qizxopen.xquery.impl.XQueryConnectionCx stub)

Method Summary

void	close() Releases memory resources used by this connection.
XQueryExpression	createExpression() Creates an empty expression sharing the static and dynamic environment.
XQueryConnection	getConnection() Returns the related connection.
XQueryPreparedExpression	prepareExpression(java.lang.String query) Compiles the source code of a query and returns a prepared Expression.

Methods inherited from class net.axyana.qizxopen.xquery.XQueryEnvironment

authorizeClass, bind, bind, bindDouble, bindLong, bindObject, bindString, bindStringArray, defineGlobal, defineNamespace, getMessages, getSysProperty, registerCollation, setCollectionInput, setCurrentItem, setDefaultCollation, setDocumentInput, setDocumentInput, setFragmentInput, setImplicitTimezone, setInput, setInputDocument, setSysProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XQueryConnection

public XQueryConnection(net.axyana.qizxopen.xquery.impl.XQueryConnectionCx stub)

Method Detail

getConnection

public XQueryConnection getConnection()

Description copied from class: XQueryEnvironment

Returns the related connection.

Specified by:

getConnection in class XQueryEnvironment

createExpression

public XQueryExpression createExpression()
                                  throws XQueryException

Creates an empty expression sharing the static and dynamic environment.

Throws:

XQueryException

prepareExpression

public XQueryPreparedExpression prepareExpression(java.lang.String query)
                                           throws XQueryException

Compiles the source code of a query and returns a prepared Expression.

Throws:

XQueryException

close

public void close()
           throws XQueryException

Releases memory resources used by this connection.

To avoid waisting resources, it is recommended to use this method once the work with a connection is done.

Any further access will raise an exception.

Throws:

XQueryException