This class defines a set of functions for managing persistent collections.
More...
List of all members.
Public Member Functions |
XQSequence | availableCollections () throws XQException |
| This function returns a sequence of names of the collections that are available.
|
void | close () throws XQException |
| Closes the collection manager.
|
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 () |
| Checks if the collection manager is closed.
|
Detailed Description
This class defines a set of functions for managing persistent collections.
Definition at line 30 of file ZorbaXQCollectionManager.java.
Constructor & Destructor Documentation
org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.ZorbaXQCollectionManager |
( |
CollectionManager |
cm | ) |
|
|
inlineprotected |
Member Function Documentation
XQSequence org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.availableCollections |
( |
| ) |
throws XQException |
|
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.
- Returns:
- The list of names of the available collections.
- Exceptions:
-
XQException | if any error occurs retreiving the collections |
Definition at line 79 of file ZorbaXQCollectionManager.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.close |
( |
| ) |
throws XQException |
|
inline |
void org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.createCollection |
( |
XQItem |
aName | ) |
throws XQException |
|
inline |
This function creates the collection with the given name.
- Parameters:
-
aName | The name of the collection to create. |
- Exceptions:
-
XQException | if a collection with the given name already exists. |
Definition at line 94 of file ZorbaXQCollectionManager.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.deleteCollection |
( |
XQItem |
aName | ) |
throws XQException |
|
inline |
This function removes the collection with the given name.
- Parameters:
-
aName | The name of the collection to delete. |
- Exceptions:
-
XQException | if the collection does not exist. |
Definition at line 106 of file ZorbaXQCollectionManager.java.
ZorbaXQCollection org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.getCollection |
( |
XQItem |
aName | ) |
throws XQException |
|
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.
- Parameters:
-
aName | The name of the collection to retrieve. |
- Exceptions:
-
XQException | if the collection does not exist. |
Definition at line 120 of file ZorbaXQCollectionManager.java.
boolean org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.isAvailableCollection |
( |
XQItem |
aName | ) |
throws XQException |
|
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.
- Parameters:
-
aName | The name of the collection that is being checked. |
- Returns:
- true if the collection is available and false otherwise.
- Exceptions:
-
XQException | if any error occurs verifying the collection |
Definition at line 139 of file ZorbaXQCollectionManager.java.
boolean org.zorbaxquery.api.xqj.ZorbaXQCollectionManager.isClosed |
( |
| ) |
|
|
inline |
Checks if the collection manager is closed.
- Returns:
- true if the collection manager is in a closed state, false otherwise
Definition at line 64 of file ZorbaXQCollectionManager.java.
The documentation for this class was generated from the following file: