This class defines a set of functions for managing persistent collections.
More...
#include <zorba/collection_manager.h>
List of all members.
Detailed Description
This class defines a set of functions for managing persistent collections.
- Examples:
-
datamanager.cpp.
Definition at line 28 of file collection_manager.h.
Constructor & Destructor Documentation
virtual zorba::CollectionManager::~CollectionManager |
( |
| ) |
[inline, virtual] |
Member Function Documentation
virtual ItemSequence_t zorba::CollectionManager::availableCollections |
( |
| ) |
const [pure virtual] |
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.
- Examples:
- datamanager.cpp.
virtual void zorba::CollectionManager::createCollection |
( |
const Item & |
aName | ) |
[pure virtual] |
This function creates the collection with the given name.
- Parameters:
-
aName | The name of the collection to create. |
- Exceptions:
-
XDDY0002 | if a collection with the given name already exists. |
- Examples:
- datamanager.cpp.
virtual void zorba::CollectionManager::createCollection |
( |
const Item & |
aName, |
|
|
const ItemSequence_t & |
aContents |
|
) |
| [pure virtual] |
This function creates the collection with the given name.
Moreover, it adds copies of the sequence aContents to the new collection.
- Parameters:
-
aName | The name of the collection to create. |
aContents | The sequence of items. |
- Exceptions:
-
XDDY0002 | if a collection with the given name already exists. |
virtual void zorba::CollectionManager::deleteCollection |
( |
const Item & |
aName | ) |
[pure virtual] |
This function removes the collection with the given name.
- Parameters:
-
aName | The name of the collection to delete. |
- Exceptions:
-
XDDY0003 | if the collection does not exist. |
- Examples:
- datamanager.cpp.
virtual Collection_t zorba::CollectionManager::getCollection |
( |
const Item & |
aName | ) |
const [pure virtual] |
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:
-
XDDY0003 | if the collection does not exist. |
- Examples:
- datamanager.cpp.
virtual bool zorba::CollectionManager::isAvailableCollection |
( |
const Item & |
aName | ) |
const [pure virtual] |
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.
- Examples:
- datamanager.cpp.
virtual void zorba::CollectionManager::registerDiagnosticHandler |
( |
DiagnosticHandler * |
aDiagnosticHandler | ) |
[pure virtual] |
The documentation for this class was generated from the following file: