Using the ZorbaXQStaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them. More...
Public Member Functions | |
XQSequence | availableCollections () throws XQException |
This function returns a sequence of names of the collections that are available. | |
void | close () throws XQException |
void | createCollection (XQItem aName) throws XQException |
This function creates the collection with the given name. | |
void | deleteCollection (XQItem aName) throws XQException |
This function removes the collection with the given name. | |
ZorbaXQCollection | getCollection (XQItem aName) throws XQException |
Returns a instance of the Collection class which can be used to modify and retrieve the contents of the collection identified by the given name. | |
boolean | isAvailableCollection (XQItem aName) throws XQException |
This function returns true if a collection with the given name is available. | |
boolean | isClosed () |
Protected Member Functions | |
ZorbaXQStaticCollectionManager (StaticCollectionManager cm) |
Using the ZorbaXQStaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them.
The ZorbaXQStaticCollectionManager can be retrieved from (1) a compiled XQuery or (2) a XQStaticContext object. In both cases, this class provides access to information for the collections and indexes that are declared in (1) all the modules (transitively) imported by the main query or (2) the module that resulted in the compilation of the StaticContext, respectively. Moreover, this class allows to create or delete such collections and indexes.
Definition at line 31 of file ZorbaXQStaticCollectionManager.java.
|
inlineprotected |
Definition at line 38 of file ZorbaXQStaticCollectionManager.java.
|
inline |
This function returns a sequence of names of the collections that are available.
If this is an instance of the StaticCollectionManager class (i.e. returned by any of the getStaticCollectionManager methods), the collections returned by this function are also statically declared.
Definition at line 62 of file ZorbaXQStaticCollectionManager.java.
|
inline |
Definition at line 42 of file ZorbaXQStaticCollectionManager.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQResultSequence.close(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequenceScrollable.close().
|
inline |
This function creates the collection with the given name.
aName | The name of the collection to create. |
XQException- | if a collection with the given name already exists. |
Definition at line 74 of file ZorbaXQStaticCollectionManager.java.
|
inline |
This function removes the collection with the given name.
aName | - The name of the collection to delete. |
XQException | - if the collection does not exist. |
Definition at line 84 of file ZorbaXQStaticCollectionManager.java.
|
inline |
Returns a instance of the Collection class which can be used to modify and retrieve the contents of the collection identified by the given name.
aName | - The name of the collection to retrieve. |
XQException | - if the collection does not exist. |
Definition at line 95 of file ZorbaXQStaticCollectionManager.java.
|
inline |
This function returns true if a collection with the given name is available.
If this is an instance of the StaticCollectionManager class (i.e. returned by any of the getStaticCollectionManager() methods), the collection also needs to be statically declared.
aName | - The name of the collection that is being checked. |
XQException | - if the Collection Manager is closed |
Definition at line 110 of file ZorbaXQStaticCollectionManager.java.
|
inline |
Definition at line 52 of file ZorbaXQStaticCollectionManager.java.