Public Member Functions | List of all members
zorba::CollectionManager Class Referenceabstract

This class defines a set of functions for managing persistent collections. More...

#include <zorba/collection_manager.h>

Inheritance diagram for zorba::CollectionManager:
Inheritance graph
[legend]

Public Member Functions

virtual ItemSequence_t availableCollections () const =0
 This function returns a sequence of names of the collections that are available. More...
 
virtual void createCollection (const Item &aName)=0
 This function creates the collection with the given name. More...
 
virtual void createCollection (const Item &aName, const ItemSequence_t &aContents)=0
 This function creates the collection with the given name. More...
 
virtual void deleteCollection (const Item &aName)=0
 This function removes the collection with the given name. More...
 
virtual Collection_t getCollection (const Item &aName) const =0
 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. More...
 
virtual bool isAvailableCollection (const Item &aName) const =0
 This function returns true if a collection with the given name is available. More...
 
virtual void registerDiagnosticHandler (DiagnosticHandler *aDiagnosticHandler)=0
 Register a DiagnosticHandler to which errors occuring during the management of collections are reported. More...
 
virtual ~CollectionManager ()
 Destructor. More...
 

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 ( )
inlinevirtual

Destructor.

Definition at line 124 of file collection_manager.h.

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
aNameThe name of the collection to create.
Exceptions
XDDY0002if 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
aNameThe name of the collection to create.
aContentsThe sequence of items.
Exceptions
XDDY0002if 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
aNameThe name of the collection to delete.
Exceptions
XDDY0003if 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
aNameThe name of the collection to retrieve.
Exceptions
XDDY0003if 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
aNameThe 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

Register a DiagnosticHandler to which errors occuring during the management of collections are reported.

If no DiagnosticHandler has been set using this function or the corresponding function of the XmlDataManager then subclasses of the ZorbaException class are thrown to report errors.

Parameters
aDiagnosticHandlerDiagnosticHandler to which errors are reported. The caller retains ownership over the DiagnosticHandler passed as parameter.

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