[u/mrichter/AliRoot.git] / STEER / CDB / AliCDBManager.h

#ifndef ALI_CDB_MANAGER_H
#define ALI_CDB_MANAGER_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/////////////////////////////////////////////////////////////////////
//                                                                 //
//  class AliCDBManager                                            //
//                                                                 //
/////////////////////////////////////////////////////////////////////

#include <TObject.h>
#include <TList.h>
#include <TMap.h>
#include <TSystem.h>
#include <TFile.h>

class AliCDBEntry;
class AliCDBId;
class AliCDBPath;
class AliCDBRunRange;
class AliCDBMetaData;
class AliCDBStorage;
class AliCDBStorageFactory;
class AliCDBParam;

class AliCDBManager: public TObject {

 public:
	enum DataType {kCondition=0, kReference, kPrivate};

	void RegisterFactory(AliCDBStorageFactory* factory);

	Bool_t HasStorage(const char* dbString) const;

	AliCDBParam* CreateParameter(const char* dbString) const;
	AliCDBParam* GetCondParam() const {return fCondParam;}
	AliCDBParam* GetRefParam() const {return fRefParam;}
	static const char* GetDataTypeName(DataType type);

	AliCDBStorage* GetStorage(const char* dbString);
	AliCDBStorage* GetStorage(const AliCDBParam* param);

	TList* GetActiveStorages();

	const TMap* GetStorageMap() const {return fStorageMap;}
	const TList* GetRetrievedIds() const {return fIds;}

	void SetDefaultStorage(const char* dbString);
	void SetDefaultStorage(const AliCDBParam* param);
	void SetDefaultStorage(AliCDBStorage *storage);
	void SetDefaultStorage(const char* runType, const char* simType);
	void SetDefaultStorageFromRun(Int_t run);

	Bool_t IsDefaultStorageSet() const {return fDefaultStorage != 0;}
	AliCDBStorage* GetDefaultStorage() const {return fDefaultStorage;}
	void UnsetDefaultStorage();

	void SetSpecificStorage(const char* calibType, const char* dbString);
	void SetSpecificStorage(const char* calibType, const AliCDBParam* param);

	AliCDBStorage* GetSpecificStorage(const char* calibType);

	void SetDrain(const char* dbString);
	void SetDrain(const AliCDBParam* param);
	void SetDrain(AliCDBStorage *storage);

	Bool_t IsDrainSet() const {return fDrainStorage != 0;}

	Bool_t Drain(AliCDBEntry* entry);

	void UnsetDrain(){fDrainStorage = 0x0;}

	AliCDBEntry* Get(const AliCDBId& query);
	AliCDBEntry* Get(const AliCDBPath& path, Int_t runNumber=-1,
				Int_t version = -1, Int_t subVersion = -1);
	AliCDBEntry* Get(const AliCDBPath& path, const AliCDBRunRange& runRange,
				 Int_t version = -1, Int_t subVersion = -1);
	AliCDBEntry* GetEntryFromSnapshot(const char* path);

	const char* GetURI(const char* path);				 
				 
	AliCDBId* GetId(const AliCDBId& query);
	AliCDBId* GetId(const AliCDBPath& path, Int_t runNumber=-1,
				Int_t version = -1, Int_t subVersion = -1);
	AliCDBId* GetId(const AliCDBPath& path, const AliCDBRunRange& runRange,
				 Int_t version = -1, Int_t subVersion = -1);

	TList* GetAll(const AliCDBId& query);
	TList* GetAll(const AliCDBPath& path, Int_t runNumber=-1,
				Int_t version = -1, Int_t subVersion = -1);
	TList* GetAll(const AliCDBPath& path, const AliCDBRunRange& runRange,
				 Int_t version = -1, Int_t subVersion = -1); 

	Bool_t Put(TObject* object, const AliCDBId& id,
			AliCDBMetaData* metaData, const DataType type=kPrivate);
	Bool_t Put(AliCDBEntry* entry, DataType type=kPrivate);

	void SetCacheFlag(Bool_t cacheFlag) {fCache=cacheFlag;}
	Bool_t GetCacheFlag() const {return fCache;}
	
	ULong_t SetLock(Bool_t lockFlag=kTRUE, ULong_t key=0);
	Bool_t GetLock() const {return fLock;}

	void SetRaw(Bool_t rawFlag){fRaw=rawFlag;}
	Bool_t GetRaw() const {return fRaw;}

	void SetRun(Int_t run);
	Int_t GetRun() const {return fRun;}

	void DestroyActiveStorages();
	void DestroyActiveStorage(AliCDBStorage* storage);

	void QueryCDB();

	void Print(Option_t* option="") const;

	static void Destroy();
	~AliCDBManager();

  	void ClearCache();
  	void UnloadFromCache(const char* path);
	const TMap* GetEntryCache() const {return &fEntryCache;}

	Bool_t IsShortLived(const char* path);

	static AliCDBManager* Instance(TMap *entryCache = NULL, Int_t run = -1);

	void Init();
	void InitFromCache(TMap *entryCache, Int_t run);
	Bool_t InitFromSnapshot(const char* snapshotFileName, Bool_t overwrite=kTRUE);
	Bool_t SetSnapshotMode(const char* snapshotFileName="OCDB.root");
	void UnsetSnapshotMode() {fSnapshotMode=kFALSE;}
	void DumpToSnapshotFile(const char* snapshotFileName, Bool_t singleKeys);
  
protected:

	static TString fgkCondUri;	// URI of the Conditions data base folder
	static TString fgkRefUri;	// URI of the Reference data base folder
	static TString fgkMCIdealStorage;	// URI of the MC-Ideal Conditions data base folder form MC data
	static TString fgkMCFullStorage;	// URI of the MC-Full Conditions data base folder form MC data
	static TString fgkMCResidualStorage;	// URI of the MC-Residual Conditions data base folder form MC data
	static TString fgkOCDBFolderXMLfile;	// alien path of the XML file for OCDB folder <--> Run range correspondance

	AliCDBManager() ; 
	AliCDBManager(const AliCDBManager & source);
	AliCDBManager & operator=(const AliCDBManager & source);

	static AliCDBManager* fgInstance; // AliCDBManager instance
	
	AliCDBStorage* GetActiveStorage(const AliCDBParam* param);
	void PutActiveStorage(AliCDBParam* param, AliCDBStorage* storage);

  	void CacheEntry(const char* path, AliCDBEntry* entry);

	AliCDBParam* SelectSpecificStorage(const TString& path);
	

//	void Init();
	void InitShortLived();
//	void InitFromCache(TMap *entryCache, Int_t run);


	TList fFactories; 		//! list of registered storage factories
	TMap fActiveStorages;		//! list of active storages
	TMap fSpecificStorages;         //! list of detector-specific storages
	TMap fEntryCache;    	  	//! cache of the retrieved objects

	TList* fIds;           	//! List of the retrieved object Id's (to be streamed to file)
	TMap* fStorageMap;      //! list of storages (to be streamed to file)
	TList* fShortLived; 	//! List of short lived objects

	AliCDBStorage *fDefaultStorage;	//! pointer to default storage
	AliCDBStorage *fDrainStorage;	//! pointer to drain storage

	AliCDBParam* fCondParam; 	// Conditions data storage parameters
	AliCDBParam* fRefParam;		// Reference data storage parameters

	Int_t fRun;			//! The run number
	Bool_t fCache;			//! The cache flag
	Bool_t fLock; 	//! Lock flag, if ON default storage and run number cannot be reset

        Bool_t fSnapshotMode;           //! flag saying if we are in snapshot mode
	TFile *fSnapshotFile;

	Bool_t fRaw;   // flag to say whether we are in the raw case
	Int_t fStartRunLHCPeriod; // 1st run of the LHC period set
	Int_t fEndRunLHCPeriod;   // last run of the LHC period set
	TString fLHCPeriod;       // LHC period alien folder

private:
   ULong_t fKey;  //! Key for locking/unlocking


	ClassDef(AliCDBManager, 0);
};


/////////////////////////////////////////////////////////////////////
//                                                                 //
//  class AliCDBStorageFactory                                     //
//                                                                 //
/////////////////////////////////////////////////////////////////////

class AliCDBParam;
class AliCDBStorageFactory: public TObject {
	friend class AliCDBManager;
	
public:
	virtual ~AliCDBStorageFactory(){}
	virtual Bool_t Validate(const char* dbString) = 0;
	virtual AliCDBParam* CreateParameter(const char* dbString) = 0;	

protected:
	virtual AliCDBStorage* Create(const AliCDBParam* param) = 0;

	ClassDef(AliCDBStorageFactory, 0);
};

/////////////////////////////////////////////////////////////////////
//                                                                 //
//  class AliCDBParam                                              //
//                                                                 //
/////////////////////////////////////////////////////////////////////

class AliCDBParam: public TObject {

public:

	AliCDBParam();
	virtual ~AliCDBParam();

	const TString& GetType() const {return fType;};
	const TString& GetURI() const {return fURI;};

	virtual AliCDBParam* CloneParam() const = 0;

protected:

	void SetType(const char* type) {fType = type;};
	void SetURI(const char* uri) {fURI = uri;};

private:

	TString fType; //! CDB type
	TString fURI;  //! CDB URI

	ClassDef(AliCDBParam, 0);
};

#endif
Commit	Line	Data
9e1ceb13	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>
27cac7e3	16	#include <TSystem.h>
c022b397	17	#include <TFile.h>
9e1ceb13	18
fdf65bb5	19	class AliCDBEntry;
02c4845e	20	class AliCDBId;
	21	class AliCDBPath;
	22	class AliCDBRunRange;
	23	class AliCDBMetaData;
9e1ceb13	24	class AliCDBStorage;
	25	class AliCDBStorageFactory;
	26	class AliCDBParam;
	27
	28	class AliCDBManager: public TObject {
	29
	30	public:
b8ec52f6	31	enum DataType {kCondition=0, kReference, kPrivate};
9e1ceb13	32
	33	void RegisterFactory(AliCDBStorageFactory* factory);
	34
fdf65bb5	35	Bool_t HasStorage(const char* dbString) const;
9e1ceb13	36
fdf65bb5	37	AliCDBParam* CreateParameter(const char* dbString) const;
b8ec52f6	38	AliCDBParam* GetCondParam() const {return fCondParam;}
	39	AliCDBParam* GetRefParam() const {return fRefParam;}
	40	static const char* GetDataTypeName(DataType type);
9e1ceb13	41
	42	AliCDBStorage* GetStorage(const char* dbString);
	43	AliCDBStorage* GetStorage(const AliCDBParam* param);
b8ec52f6	44
9e1ceb13	45	TList* GetActiveStorages();
9e1ceb13	46
b21e3194	47	const TMap* GetStorageMap() const {return fStorageMap;}
	48	const TList* GetRetrievedIds() const {return fIds;}
	49
9e1ceb13	50	void SetDefaultStorage(const char* dbString);
	51	void SetDefaultStorage(const AliCDBParam* param);
	52	void SetDefaultStorage(AliCDBStorage *storage);
7de84b33	53	void SetDefaultStorage(const char* runType, const char* simType);
7de84b33	54	void SetDefaultStorageFromRun(Int_t run);
4667c116	55
02c4845e	56	Bool_t IsDefaultStorageSet() const {return fDefaultStorage != 0;}
fdf65bb5	57	AliCDBStorage* GetDefaultStorage() const {return fDefaultStorage;}
1f341624	58	void UnsetDefaultStorage();
4667c116	59
024cf675	60	void SetSpecificStorage(const char* calibType, const char* dbString);
647d2bb8	61	void SetSpecificStorage(const char* calibType, const AliCDBParam* param);
02c4845e	62
024cf675	63	AliCDBStorage* GetSpecificStorage(const char* calibType);
9e1ceb13	64
	65	void SetDrain(const char* dbString);
	66	void SetDrain(const AliCDBParam* param);
	67	void SetDrain(AliCDBStorage *storage);
	68
fdf65bb5	69	Bool_t IsDrainSet() const {return fDrainStorage != 0;}
9e1ceb13	70
	71	Bool_t Drain(AliCDBEntry* entry);
	72
b05400be	73	void UnsetDrain(){fDrainStorage = 0x0;}
9e1ceb13	74
02c4845e	75	AliCDBEntry* Get(const AliCDBId& query);
62032124	76	AliCDBEntry* Get(const AliCDBPath& path, Int_t runNumber=-1,
02c4845e	77	Int_t version = -1, Int_t subVersion = -1);
	78	AliCDBEntry* Get(const AliCDBPath& path, const AliCDBRunRange& runRange,
	79	Int_t version = -1, Int_t subVersion = -1);
c022b397	80	AliCDBEntry* GetEntryFromSnapshot(const char* path);
02c4845e	81
0f40a831	82	const char* GetURI(const char* path);
0f40a831	83
4667c116	84	AliCDBId* GetId(const AliCDBId& query);
	85	AliCDBId* GetId(const AliCDBPath& path, Int_t runNumber=-1,
	86	Int_t version = -1, Int_t subVersion = -1);
	87	AliCDBId* GetId(const AliCDBPath& path, const AliCDBRunRange& runRange,
	88	Int_t version = -1, Int_t subVersion = -1);
	89
02c4845e	90	TList* GetAll(const AliCDBId& query);
62032124	91	TList* GetAll(const AliCDBPath& path, Int_t runNumber=-1,
02c4845e	92	Int_t version = -1, Int_t subVersion = -1);
	93	TList* GetAll(const AliCDBPath& path, const AliCDBRunRange& runRange,
	94	Int_t version = -1, Int_t subVersion = -1);
	95
647d2bb8	96	Bool_t Put(TObject* object, const AliCDBId& id,
27cac7e3	97	AliCDBMetaData* metaData, const DataType type=kPrivate);
b8ec52f6	98	Bool_t Put(AliCDBEntry* entry, DataType type=kPrivate);
b8ec52f6	99
4b5e0dce	100	void SetCacheFlag(Bool_t cacheFlag) {fCache=cacheFlag;}
e1e6896f	101	Bool_t GetCacheFlag() const {return fCache;}
1f341624	102
a6f59240	103	ULong_t SetLock(Bool_t lockFlag=kTRUE, ULong_t key=0);
1f341624	104	Bool_t GetLock() const {return fLock;}
4b5e0dce	105
7de84b33	106	void SetRaw(Bool_t rawFlag){fRaw=rawFlag;}
	107	Bool_t GetRaw() const {return fRaw;}
	108
c3a7b59a	109	void SetRun(Int_t run);
c3a7b59a	110	Int_t GetRun() const {return fRun;}
4b5e0dce	111
9e1ceb13	112	void DestroyActiveStorages();
9e1ceb13	113	void DestroyActiveStorage(AliCDBStorage* storage);
917a098b	114
62032124	115	void QueryCDB();
62032124	116
917a098b	117	void Print(Option_t* option="") const;
917a098b	118
9e1ceb13	119	static void Destroy();
	120	~AliCDBManager();
	121
8e245d15	122	void ClearCache();
4005d0b5	123	void UnloadFromCache(const char* path);
d1982b43	124	const TMap* GetEntryCache() const {return &fEntryCache;}
8e245d15	125
4667c116	126	Bool_t IsShortLived(const char* path);
4667c116	127
d1982b43	128	static AliCDBManager* Instance(TMap *entryCache = NULL, Int_t run = -1);
9e1ceb13	129
b03591ab	130	void Init();
b03591ab	131	void InitFromCache(TMap *entryCache, Int_t run);
b0e8cda6	132	Bool_t InitFromSnapshot(const char* snapshotFileName, Bool_t overwrite=kTRUE);
c022b397	133	Bool_t SetSnapshotMode(const char* snapshotFileName="OCDB.root");
	134	void UnsetSnapshotMode() {fSnapshotMode=kFALSE;}
	135	void DumpToSnapshotFile(const char* snapshotFileName, Bool_t singleKeys);
b03591ab	136
b03591ab	137	protected:
b8ec52f6	138
	139	static TString fgkCondUri; // URI of the Conditions data base folder
	140	static TString fgkRefUri; // URI of the Reference data base folder
7de84b33	141	static TString fgkMCIdealStorage; // URI of the MC-Ideal Conditions data base folder form MC data
	142	static TString fgkMCFullStorage; // URI of the MC-Full Conditions data base folder form MC data
	143	static TString fgkMCResidualStorage; // URI of the MC-Residual Conditions data base folder form MC data
	144	static TString fgkOCDBFolderXMLfile; // alien path of the XML file for OCDB folder <--> Run range correspondance
b8ec52f6	145
b03591ab	146	AliCDBManager() ;
fe12e09c	147	AliCDBManager(const AliCDBManager & source);
	148	AliCDBManager & operator=(const AliCDBManager & source);
	149
fdf65bb5	150	static AliCDBManager* fgInstance; // AliCDBManager instance
9e1ceb13	151
	152	AliCDBStorage* GetActiveStorage(const AliCDBParam* param);
	153	void PutActiveStorage(AliCDBParam* param, AliCDBStorage* storage);
917a098b	154
4b5e0dce	155	void CacheEntry(const char* path, AliCDBEntry* entry);
8e245d15	156
024cf675	157	AliCDBParam* SelectSpecificStorage(const TString& path);
024cf675	158
9e1ceb13	159
b03591ab	160	// void Init();
4667c116	161	void InitShortLived();
b03591ab	162	// void InitFromCache(TMap *entryCache, Int_t run);
4667c116	163
4667c116	164
b05400be	165	TList fFactories; //! list of registered storage factories
b05400be	166	TMap fActiveStorages; //! list of active storages
02c4845e	167	TMap fSpecificStorages; //! list of detector-specific storages
b21e3194	168	TMap fEntryCache; //! cache of the retrieved objects
	169
	170	TList* fIds; //! List of the retrieved object Id's (to be streamed to file)
	171	TMap* fStorageMap; //! list of storages (to be streamed to file)
	172	TList* fShortLived; //! List of short lived objects
4b5e0dce	173
b05400be	174	AliCDBStorage *fDefaultStorage; //! pointer to default storage
b05400be	175	AliCDBStorage *fDrainStorage; //! pointer to drain storage
9e1ceb13	176
b21e3194	177	AliCDBParam* fCondParam; // Conditions data storage parameters
b21e3194	178	AliCDBParam* fRefParam; // Reference data storage parameters
4b5e0dce	179
b21e3194	180	Int_t fRun; //! The run number
4b5e0dce	181	Bool_t fCache; //! The cache flag
1f341624	182	Bool_t fLock; //! Lock flag, if ON default storage and run number cannot be reset
4b5e0dce	183
c022b397	184	Bool_t fSnapshotMode; //! flag saying if we are in snapshot mode
c022b397	185	TFile *fSnapshotFile;
c022b397	186
7de84b33	187	Bool_t fRaw; // flag to say whether we are in the raw case
	188	Int_t fStartRunLHCPeriod; // 1st run of the LHC period set
	189	Int_t fEndRunLHCPeriod; // last run of the LHC period set
	190	TString fLHCPeriod; // LHC period alien folder
	191
a6f59240	192	private:
	193	ULong_t fKey; //! Key for locking/unlocking
	194
4667c116	195
9e1ceb13	196	ClassDef(AliCDBManager, 0);
	197	};
	198
	199
	200	/////////////////////////////////////////////////////////////////////
	201	// //
	202	// class AliCDBStorageFactory //
	203	// //
	204	/////////////////////////////////////////////////////////////////////
	205
	206	class AliCDBParam;
	207	class AliCDBStorageFactory: public TObject {
	208	friend class AliCDBManager;
	209
	210	public:
e1e6896f	211	virtual ~AliCDBStorageFactory(){}
9e1ceb13	212	virtual Bool_t Validate(const char* dbString) = 0;
b05400be	213	virtual AliCDBParam* CreateParameter(const char* dbString) = 0;
9e1ceb13	214
	215	protected:
	216	virtual AliCDBStorage* Create(const AliCDBParam* param) = 0;
	217
	218	ClassDef(AliCDBStorageFactory, 0);
	219	};
	220
	221	/////////////////////////////////////////////////////////////////////
	222	// //
	223	// class AliCDBParam //
	224	// //
	225	/////////////////////////////////////////////////////////////////////
	226
	227	class AliCDBParam: public TObject {
	228
	229	public:
	230
	231	AliCDBParam();
	232	virtual ~AliCDBParam();
	233
	234	const TString& GetType() const {return fType;};
	235	const TString& GetURI() const {return fURI;};
	236
	237	virtual AliCDBParam* CloneParam() const = 0;
	238
	239	protected:
	240
	241	void SetType(const char* type) {fType = type;};
	242	void SetURI(const char* uri) {fURI = uri;};
	243
	244	private:
	245
917a098b	246	TString fType; //! CDB type
917a098b	247	TString fURI; //! CDB URI
9e1ceb13	248
	249	ClassDef(AliCDBParam, 0);
	250	};
	251
	252	#endif