Using the StaticCollectionManager one can retrieve information about statically declared collections and indexes as well as manage them. More...
Public Member Functions | |
ItemSequence | availableCollections () |
This function returns a sequence of names of the collections that are available. | |
ItemSequence | availableIndexes () |
This function returns a sequence of names of the indexes that are available. | |
void | createCollection (const Item &aName) |
This function creates the collection with the given name. | |
void | createCollection (const Item &aName, const ItemSequence &aContents) |
This function creates the collection with the given name. | |
void | createIndex (const Item &aQName) |
Create the index with the given name. | |
ItemSequence | declaredCollections () |
List all the collections that are declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager. | |
ItemSequence | declaredIndexes () |
List all the indexes that are declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager. | |
void | deleteCollection (const Item &aName) |
This function removes the collection with the given name. | |
void | deleteIndex (const Item &aQName) |
Create the index with the given name. | |
Collection | getCollection (const Item &aName) |
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. | |
bool | isAvailableCollection (const Item &aName) |
This function returns true if a collection with the given name is available. | |
bool | isAvailableIndex (const Item &aQName) |
This function returns true if a index with the given name is available. | |
bool | isDeclaredCollection (const Item &aQName) |
Checks if a collection with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager. | |
bool | isDeclaredIndex (const Item &aQName) |
Checks if a index with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager. | |
void | registerDiagnosticHandler (DiagnosticHandler *aDiagnosticHandler) |
Register a DiagnosticHandler to which errors occuring during the management of collections are reported. | |
StaticCollectionManager (const StaticCollectionManager &aMgr) | |
StaticCollectionManager (zorba::StaticCollectionManager *aMgr) |
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 30 of file StaticCollectionManager.h.
|
inline |
Definition at line 36 of file StaticCollectionManager.h.
|
inline |
Definition at line 37 of file StaticCollectionManager.h.
ItemSequence StaticCollectionManager::availableCollections | ( | ) |
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.
ItemSequence StaticCollectionManager::availableIndexes | ( | ) |
This function returns a sequence of names of the indexes that are available.
void StaticCollectionManager::createCollection | ( | const Item & | aName | ) |
This function creates the collection with the given name.
aName | The name of the collection to create. |
XDDY0002 | if a collection with the given name already exists. |
void StaticCollectionManager::createCollection | ( | const Item & | aName, |
const ItemSequence & | aContents | ||
) |
This function creates the collection with the given name.
Moreover, it adds copies of the sequence aContents to the new collection.
aName | The name of the collection to create. |
aContents | The sequence of items. |
XDDY0002 | if a collection with the given name already exists. |
void StaticCollectionManager::createIndex | ( | const Item & | aQName | ) |
Create the index with the given name.
aQName | The name of the index to create. |
zerr:ZDDY0021 | if a index with the given name is not declared. |
zerr:ZDDY0022 | if a index with the given name already exists. |
ItemSequence StaticCollectionManager::declaredCollections | ( | ) |
List all the collections that are declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
ItemSequence StaticCollectionManager::declaredIndexes | ( | ) |
List all the indexes that are declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
void StaticCollectionManager::deleteCollection | ( | const Item & | aName | ) |
This function removes the collection with the given name.
aName | The name of the collection to delete. |
XDDY0003 | if the collection does not exist. |
void StaticCollectionManager::deleteIndex | ( | const Item & | aQName | ) |
Create the index with the given name.
aQName | The name of the index to create. |
zerr:ZDDY0021 | if a index with the given name is not declared. |
zerr:ZDDY0009 | if a index with the given name does not exist |
Collection StaticCollectionManager::getCollection | ( | const Item & | aName | ) |
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. |
XDDY0003 | if the collection does not exist. |
bool StaticCollectionManager::isAvailableCollection | ( | const Item & | aName | ) |
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. |
bool StaticCollectionManager::isAvailableIndex | ( | const Item & | aQName | ) |
This function returns true if a index with the given name is available.
aQName | The name of the index that is being checked. |
bool StaticCollectionManager::isDeclaredCollection | ( | const Item & | aQName | ) |
Checks if a collection with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
bool StaticCollectionManager::isDeclaredIndex | ( | const Item & | aQName | ) |
Checks if a index with a given QName is declared in the XQuery or the StaticContext that was used to retrieve this StaticCollectionManager.
void StaticCollectionManager::registerDiagnosticHandler | ( | DiagnosticHandler * | aDiagnosticHandler | ) |
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.
aDiagnosticHandler | DiagnosticHandler to which errors are reported. The caller retains ownership over the DiagnosticHandler passed as parameter. |