Using the StaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them.
More...
#include <zorba/static_collection_manager.h>
Using the StaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them.
The StaticCollectionManager can be retrieved from (1) a compiled XQuery or (2) a StaticContext 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 36 of file static_collection_manager.h.
virtual zorba::StaticCollectionManager::~StaticCollectionManager |
( |
) | |
|
|
inlinevirtual |
virtual ItemSequence_t zorba::CollectionManager::availableCollections |
( |
) | |
const |
|
pure virtualinherited |
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 ItemSequence_t zorba::StaticCollectionManager::availableIndexes |
( |
) | |
const |
|
pure virtual |
This function returns a sequence of names of the indexes that are available.
- Returns
- The list of names of the available indexes.
virtual void zorba::CollectionManager::createCollection |
( |
const Item & |
aName) | |
|
|
pure virtualinherited |
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 virtualinherited |
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::StaticCollectionManager::createIndex |
( |
const Item & |
aQName) | |
|
|
pure virtual |
Create the index with the given name.
- Parameters
-
aQName | The name of the index to create. |
- Exceptions
-
zerr:ZDDY0021 | if a index with the given name is not declared. |
zerr:ZDDY0022 | if a index with the given name already exists. |
virtual ItemSequence_t zorba::StaticCollectionManager::declaredCollections |
( |
) | |
const |
|
pure virtual |
virtual ItemSequence_t zorba::StaticCollectionManager::declaredIndexes |
( |
) | |
const |
|
pure virtual |
virtual void zorba::CollectionManager::deleteCollection |
( |
const Item & |
aName) | |
|
|
pure virtualinherited |
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 void zorba::StaticCollectionManager::deleteIndex |
( |
const Item & |
aQName) | |
|
|
pure virtual |
Create the index with the given name.
- Parameters
-
aQName | The name of the index to create. |
- Exceptions
-
zerr:ZDDY0021 | if a index with the given name is not declared. |
zerr:ZDDY0009 | if a index with the given name does not exist |
virtual Collection_t zorba::CollectionManager::getCollection |
( |
const Item & |
aName) | |
const |
|
pure virtualinherited |
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 virtualinherited |
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 bool zorba::StaticCollectionManager::isAvailableIndex |
( |
const Item & |
aQName) | |
const |
|
pure virtual |
This function returns true if a index with the given name is available.
- Parameters
-
aQName | The name of the index that is being checked. |
- Returns
- true if the index is available and false otherwise.
virtual bool zorba::StaticCollectionManager::isDeclaredCollection |
( |
const Item & |
aQName) | |
const |
|
pure virtual |
Checks if a collection with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
- Returns
- true if a collection with the given name is declared, false otherwise.
virtual bool zorba::StaticCollectionManager::isDeclaredIndex |
( |
const Item & |
aQName) | |
const |
|
pure virtual |
Checks if a index with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
- Returns
- true if a collection with the given name is declared, false otherwise.
virtual void zorba::CollectionManager::registerDiagnosticHandler |
( |
DiagnosticHandler * |
aDiagnosticHandler) | |
|
|
pure virtualinherited |
The documentation for this class was generated from the following file: