STEER/AliCDBManager.h

   1 #ifndef ALI_CDB_MANAGER_H
   2 #define ALI_CDB_MANAGER_H
   3
   4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   5  * See cxx source for full Copyright notice                               */
   6
   7 /////////////////////////////////////////////////////////////////////
   8 //                                                                 //
   9 //  class AliCDBManager                                            //
  10 //                                                                 //
  11 /////////////////////////////////////////////////////////////////////
  12
  13 #include <TObject.h>
  14 #include <TList.h>
  15 #include <TMap.h>
  16
  17 class AliCDBEntry;
  18 class AliCDBId;
  19 class AliCDBPath;
  20 class AliCDBRunRange;
  21 class AliCDBMetaData;
  22 class AliCDBStorage;
  23 class AliCDBStorageFactory;
  24 class AliCDBParam;
  25
  26 class AliCDBManager: public TObject {
  27
  28  public:
  29         enum DataType {kCondition=0, kReference, kPrivate};
  30
  31         void RegisterFactory(AliCDBStorageFactory* factory);
  32
  33         Bool_t HasStorage(const char* dbString) const;
  34
  35         AliCDBParam* CreateParameter(const char* dbString) const;
  36         AliCDBParam* GetCondParam() const {return fCondParam;}
  37         AliCDBParam* GetRefParam() const {return fRefParam;}
  38         static const char* GetDataTypeName(DataType type);
  39
  40         AliCDBStorage* GetStorage(const char* dbString);
  41         AliCDBStorage* GetStorage(const AliCDBParam* param);
  42
  43         TList* GetActiveStorages();
  44
  45         const TMap* GetStorageMap() const {return fStorageMap;}
  46         const TList* GetRetrievedIds() const {return fIds;}
  47
  48         void SetDefaultStorage(const char* dbString);
  49         void SetDefaultStorage(const AliCDBParam* param);
  50         void SetDefaultStorage(AliCDBStorage *storage);
  51
  52         Bool_t IsDefaultStorageSet() const {return fDefaultStorage != 0;}
  53         AliCDBStorage* GetDefaultStorage() const {return fDefaultStorage;}
  54         void UnsetDefaultStorage();
  55
  56         void SetSpecificStorage(const char* calibType, const char* dbString);
  57         void SetSpecificStorage(const char* calibType, AliCDBParam* param);
  58
  59         AliCDBStorage* GetSpecificStorage(const char* calibType);
  60
  61         void SetDrain(const char* dbString);
  62         void SetDrain(const AliCDBParam* param);
  63         void SetDrain(AliCDBStorage *storage);
  64
  65         Bool_t IsDrainSet() const {return fDrainStorage != 0;}
  66
  67         Bool_t Drain(AliCDBEntry* entry);
  68
  69         void UnsetDrain(){fDrainStorage = 0x0;}
  70
  71         AliCDBEntry* Get(const AliCDBId& query);
  72         AliCDBEntry* Get(const AliCDBPath& path, Int_t runNumber=-1,
  73                                 Int_t version = -1, Int_t subVersion = -1);
  74         AliCDBEntry* Get(const AliCDBPath& path, const AliCDBRunRange& runRange,
  75                                  Int_t version = -1, Int_t subVersion = -1);
  76
  77         AliCDBId* GetId(const AliCDBId& query);
  78         AliCDBId* GetId(const AliCDBPath& path, Int_t runNumber=-1,
  79                                 Int_t version = -1, Int_t subVersion = -1);
  80         AliCDBId* GetId(const AliCDBPath& path, const AliCDBRunRange& runRange,
  81                                  Int_t version = -1, Int_t subVersion = -1);
  82
  83         TList* GetAll(const AliCDBId& query);
  84         TList* GetAll(const AliCDBPath& path, Int_t runNumber=-1,
  85                                 Int_t version = -1, Int_t subVersion = -1);
  86         TList* GetAll(const AliCDBPath& path, const AliCDBRunRange& runRange,
  87                                  Int_t version = -1, Int_t subVersion = -1);
  88
  89         Bool_t Put(TObject* object, AliCDBId& id,
  90                         AliCDBMetaData* metaData, DataType type=kPrivate);
  91         Bool_t Put(AliCDBEntry* entry, DataType type=kPrivate);
  92
  93         void SetCacheFlag(Bool_t cacheFlag) {fCache=cacheFlag;}
  94         Bool_t GetCacheFlag() const {return fCache;}
  95
  96         void SetLock(Bool_t lockFlag=kTRUE);
  97         Bool_t GetLock() const {return fLock;}
  98
  99         void SetRun(Int_t run);
 100         Int_t GetRun() const {return fRun;}
 101
 102         void DestroyActiveStorages();
 103         void DestroyActiveStorage(AliCDBStorage* storage);
 104
 105         void QueryCDB();
 106
 107         void Print(Option_t* option="") const;
 108
 109         static void Destroy();
 110         ~AliCDBManager();
 111
 112         void ClearCache();
 113         void UnloadFromCache(const char* path);
 114
 115         Bool_t IsShortLived(const char* path);
 116
 117         static AliCDBManager* Instance();
 118
 119  private:
 120
 121         static TString fgkCondUri;      // URI of the Conditions data base folder
 122         static TString fgkRefUri;       // URI of the Reference data base folder
 123
 124         AliCDBManager();
 125         AliCDBManager(const AliCDBManager & source);
 126         AliCDBManager & operator=(const AliCDBManager & source);
 127
 128         static AliCDBManager* fgInstance; // AliCDBManager instance
 129
 130         AliCDBStorage* GetActiveStorage(const AliCDBParam* param);
 131         void PutActiveStorage(AliCDBParam* param, AliCDBStorage* storage);
 132
 133         void CacheEntry(const char* path, AliCDBEntry* entry);
 134
 135         AliCDBParam* SelectSpecificStorage(const TString& path);
 136
 137
 138         void Init();
 139         void InitShortLived();
 140
 141
 142         TList fFactories;               //! list of registered storage factories
 143         TMap fActiveStorages;           //! list of active storages
 144         TMap fSpecificStorages;         //! list of detector-specific storages
 145         TMap fEntryCache;               //! cache of the retrieved objects
 146
 147         TList* fIds;            //! List of the retrieved object Id's (to be streamed to file)
 148         TMap* fStorageMap;      //! list of storages (to be streamed to file)
 149         TList* fShortLived;     //! List of short lived objects
 150
 151         AliCDBStorage *fDefaultStorage; //! pointer to default storage
 152         AliCDBStorage *fDrainStorage;   //! pointer to drain storage
 153
 154         AliCDBParam* fCondParam;        // Conditions data storage parameters
 155         AliCDBParam* fRefParam;         // Reference data storage parameters
 156
 157         Int_t fRun;                     //! The run number
 158         Bool_t fCache;                  //! The cache flag
 159         Bool_t fLock;   //! Lock flag, if ON default storage and run number cannot be reset
 160
 161
 162         ClassDef(AliCDBManager, 0);
 163 };
 164
 165
 166 /////////////////////////////////////////////////////////////////////
 167 //                                                                 //
 168 //  class AliCDBStorageFactory                                     //
 169 //                                                                 //
 170 /////////////////////////////////////////////////////////////////////
 171
 172 class AliCDBParam;
 173 class AliCDBStorageFactory: public TObject {
 174         friend class AliCDBManager;
 175
 176 public:
 177         virtual ~AliCDBStorageFactory(){}
 178         virtual Bool_t Validate(const char* dbString) = 0;
 179         virtual AliCDBParam* CreateParameter(const char* dbString) = 0;
 180
 181 protected:
 182         virtual AliCDBStorage* Create(const AliCDBParam* param) = 0;
 183
 184         ClassDef(AliCDBStorageFactory, 0);
 185 };
 186
 187 /////////////////////////////////////////////////////////////////////
 188 //                                                                 //
 189 //  class AliCDBParam                                              //
 190 //                                                                 //
 191 /////////////////////////////////////////////////////////////////////
 192
 193 class AliCDBParam: public TObject {
 194
 195 public:
 196
 197         AliCDBParam();
 198         virtual ~AliCDBParam();
 199
 200         const TString& GetType() const {return fType;};
 201         const TString& GetURI() const {return fURI;};
 202
 203         virtual AliCDBParam* CloneParam() const = 0;
 204
 205 protected:
 206
 207         void SetType(const char* type) {fType = type;};
 208         void SetURI(const char* uri) {fURI = uri;};
 209
 210 private:
 211
 212         TString fType; //! CDB type
 213         TString fURI;  //! CDB URI
 214
 215         ClassDef(AliCDBParam, 0);
 216 };
 217
 218 #endif