00001 /* 00002 * Copyright 2006-2011 The FLWOR Foundation. 00003 * 00004 * Licensed under the Apache License, Version 2.0 (the "License"); 00005 * you may not use this file except in compliance with the License. 00006 * You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 #ifndef ZORBA_STATICCOLLECTIONMANAGER_API_H 00017 #define ZORBA_STATICCOLLECTIONMANAGER_API_H 00018 00019 #include <zorba/config.h> 00020 #include <zorba/api_shared_types.h> 00021 #include <zorba/collection_manager.h> 00022 00023 namespace zorba { 00024 00025 /** \brief Using the StaticCollectionManager one can retrieve information 00026 * about statically declared collections and indexes as well as manage them. 00027 * 00028 * The StaticCollectionManager can be retrieved from (1) a compiled XQuery 00029 * or (2) a StaticContext object. In both cases, this class provides access 00030 * to information for the collections and indexes that are declared in (1) all the 00031 * modules (transitively) imported by the main query or (2) the module 00032 * that resulted in the compilation of the StaticContext, respectively. 00033 * Moreover, this class allows to create or delete such collections and indexes. 00034 * 00035 */ 00036 class ZORBA_DLL_PUBLIC StaticCollectionManager : public CollectionManager 00037 { 00038 public: 00039 /** 00040 * List all the collections that are declared in the XQuery or the 00041 * StaticContext that was used to retrieve this StaticCollectionManager. 00042 * 00043 * @return a sequence of QNames of all said collections 00044 */ 00045 virtual ItemSequence_t 00046 declaredCollections() const = 0; 00047 00048 /** 00049 * Checks if a collection with a given QName is declared in the XQuery 00050 * or the StaticContext that was used to retrieve this 00051 * StaticCollectionManager. 00052 * 00053 * @return true if a collection with the given name is declared, 00054 * false otherwise. 00055 */ 00056 virtual bool 00057 isDeclaredCollection(const Item& aQName) const = 0; 00058 00059 /** 00060 * Create the index with the given name. 00061 * 00062 * @param aQName The name of the index to create. 00063 * 00064 * @throw zerr:ZDDY0021 if a index with the given name is not declared. 00065 * 00066 * @throw zerr:ZDDY0022 if a index with the given name already exists. 00067 */ 00068 virtual void 00069 createIndex(const Item& aQName) = 0; 00070 00071 /** 00072 * Create the index with the given name. 00073 * 00074 * @param aQName The name of the index to create. 00075 * 00076 * @throw zerr:ZDDY0021 if a index with the given name is not declared. 00077 * 00078 * @throw zerr:ZDDY0009 if a index with the given name does not exist 00079 */ 00080 virtual void 00081 deleteIndex(const Item& aQName) = 0; 00082 00083 /** 00084 * This function returns a sequence of names of the indexes 00085 * that are available. 00086 * 00087 * @return The list of names of the available indexes. 00088 */ 00089 virtual ItemSequence_t 00090 availableIndexes() const = 0; 00091 00092 /** 00093 * This function returns true if a index with the given name is available. 00094 * 00095 * @param aQName The name of the index that is being checked. 00096 * 00097 * @return true if the index is available and false otherwise. 00098 */ 00099 virtual bool 00100 isAvailableIndex(const Item& aQName) const = 0; 00101 00102 /** 00103 * List all the indexes that are declared in the XQuery or the 00104 * StaticContext that was used to retrieve this StaticCollectionManager. 00105 * 00106 * @return a sequence of QNames of all said indexes 00107 */ 00108 virtual ItemSequence_t 00109 declaredIndexes() const = 0; 00110 00111 /** 00112 * Checks if a index with a given QName is declared in the XQuery 00113 * or the StaticContext that was used to retrieve this 00114 * StaticCollectionManager. 00115 * 00116 * @return true if a collection with the given name is declared, 00117 * false otherwise. 00118 */ 00119 virtual bool 00120 isDeclaredIndex(const Item& aQName) const = 0; 00121 00122 virtual ~StaticCollectionManager() {} 00123 00124 }; /* class StaticCollectionManager */ 00125 00126 } /* namespace zorba */ 00127 #endif 00128 /* vim:set et sw=2 ts=2: */