[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>

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);

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