Public Member Functions | Protected Member Functions | List of all members
org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager Class Reference

Using the ZorbaXQXmlDataManager one can manage documents and collections. More...

Public Member Functions

void close () throws XQException
 Close the XmlDataManager and release all the resources associated with this item. More...
 
ZorbaXQCollectionManager getCollectionManager () throws XQException
 Returns a CollectionManager responsible for all collections. More...
 
ZorbaXQDocumentManager getDocumentManager () throws XQException
 
ZorbaXQCollectionManager getW3CCollectionManager () throws XQException
 Returns a CollectionManager responsible for collections identified by a URI. More...
 
boolean isClosed ()
 Checks if the ZorbaXQXmlDataManager is closed. More...
 
ZorbaXQSequence parseXML (String xmlText) throws XQException
 Parse an XML document and return an ZorbaXQSequence. More...
 

Protected Member Functions

 ZorbaXQXmlDataManager (Zorba zorba)
 

Detailed Description

Using the ZorbaXQXmlDataManager one can manage documents and collections.

The ZorbaXQXmlDataManager is a singleton instance. The XQConnection object is reponsible for maintaining its lifetime. The instance can be accessed by calling getXmlDataManager() on the XQConnection object. It may not be accessed anymore after XQConnection is closed.

Definition at line 32 of file ZorbaXQXmlDataManager.java.

Constructor & Destructor Documentation

org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.ZorbaXQXmlDataManager ( Zorba  zorba)
inlineprotected

Definition at line 41 of file ZorbaXQXmlDataManager.java.

Member Function Documentation

void org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.close ( ) throws XQException
inline

Close the XmlDataManager and release all the resources associated with this item.

Close the XmlDataManager and release all the resources associated with this item. No method other than the isClosed or close method may be called once the XmlDataManager is closed. Calling close on an XmlDataManager object that is already closed has no effect.

Exceptions
XQException- if there is an error during closing the item

Definition at line 51 of file ZorbaXQXmlDataManager.java.

References org.zorbaxquery.api.xqj.ZorbaXQDocumentManager.close(), and org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.close().

Referenced by org.zorbaxquery.api.xqj.ZorbaXQConnection.close().

ZorbaXQCollectionManager org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.getCollectionManager ( ) throws XQException
inline

Returns a CollectionManager responsible for all collections.

The collection manager provides a set of functions for managing collections identified by a QName and their contents.

Please note that the resulting manager is only responsible for dynamic collections identified by a QName, i.e. those that are not declared in the prolog of a module or identified by a URI.

Returns
The collection manager responsible for managing collections.

Definition at line 95 of file ZorbaXQXmlDataManager.java.

ZorbaXQDocumentManager org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.getDocumentManager ( ) throws XQException
inline

Definition at line 80 of file ZorbaXQXmlDataManager.java.

ZorbaXQCollectionManager org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.getW3CCollectionManager ( ) throws XQException
inline

Returns a CollectionManager responsible for collections identified by a URI.

The collection manager provides a set of functions for managing collections identified by a URI and their contents.

Please note that the resulting manager is only responsible for dynamic collections identified by a URI, i.e. those that are not declared in the prolog of a module or identified by a QName.

Returns
The collection manager responsible for managing collections.

Definition at line 110 of file ZorbaXQXmlDataManager.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.isClosed ( )
inline

Checks if the ZorbaXQXmlDataManager is closed.

Checks if the ZorbaXQXmlDataManager is closed.

Returns
boolean true if the ZorbaXQXmlDataManager is in a closed state, false otherwise

Definition at line 76 of file ZorbaXQXmlDataManager.java.

ZorbaXQSequence org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.parseXML ( String  xmlText) throws XQException
inline

Parse an XML document and return an ZorbaXQSequence.

Definition at line 121 of file ZorbaXQXmlDataManager.java.


The documentation for this class was generated from the following file: