The Gaudi Framework  v30r3 (a5ef0a68)
IFileCatalog.h
Go to the documentation of this file.
1 #ifndef GAUDIFILECATALOG_IFILECATALOG_H
2 #define GAUDIFILECATALOG_IFILECATALOG_H
3 
4 #include "GaudiKernel/IInterface.h"
5 #include <Gaudi/PluginService.h>
6 #include <string>
7 #include <utility>
8 #include <vector>
9 
10 class IMessageSvc;
11 
12 /*
13  * Gaudi namespace declaration
14  */
15 namespace Gaudi
16 {
17 
27  class GAUDI_API IFileCatalog : virtual public IInterface
28  {
29 
30  public:
32  DeclareInterfaceID( IFileCatalog, 2, 0 );
33 
34  using Factory = Gaudi::PluginService::Factory<IInterface*( const std::string&, IMessageSvc* )>;
35 
37  typedef std::pair<std::string, std::string> NamedItem;
38  typedef std::vector<NamedItem> Attributes;
39  typedef std::vector<NamedItem> Files;
40  typedef std::vector<std::string> Strings;
41 
43  virtual std::string createFID() const = 0;
46  virtual const std::string& connectInfo() const = 0;
48  virtual void init() = 0;
50  virtual void commit() = 0;
52  virtual void rollback() = 0;
54  virtual bool readOnly() const = 0;
56  virtual bool dirty() const = 0;
58  virtual void getPFN( const std::string& fid, Files& files ) const = 0;
60  virtual void getLFN( const std::string& fid, Files& files ) const = 0;
62  virtual void getFID( Strings& fids ) const = 0;
64  virtual bool existsPFN( const std::string& pfn ) const = 0;
66  virtual std::string lookupPFN( const std::string& lfn ) const = 0;
68  virtual bool existsLFN( const std::string& lfn ) const = 0;
70  virtual std::string lookupLFN( const std::string& lfn ) const = 0;
72  virtual bool existsFID( const std::string& fid ) const = 0;
74  virtual void deleteFID( const std::string& FileID ) const = 0;
76  virtual void registerPFN( const std::string& fid, const std::string& pfn, const std::string& ftype ) const = 0;
78  virtual void registerLFN( const std::string& fid, const std::string& lfn ) const = 0;
80  virtual void registerFID( const std::string& fid ) const = 0;
82  virtual void renamePFN( const std::string& pfn, const std::string& new_pfn ) const = 0;
84  virtual void deletePFN( const std::string& pfn ) const = 0;
86  virtual void getMetaData( const std::string& fid, Attributes& attr ) const = 0;
88  virtual std::string getMetaDataItem( const std::string& fid, const std::string& name ) const = 0;
90  virtual void setMetaData( const std::string& fid, const std::string& name, const std::string& value ) const = 0;
92  virtual void dropMetaData( const std::string& fid ) const = 0;
94  virtual void dropMetaData( const std::string& fid, const std::string& attr ) const = 0;
95  };
96 } /* End namespace Gaudi */
97 #endif /* GAUDIFILECATALOG_IFILECATALOG_H */
Gaudi::IFileCatalog::NamedItem
std::pair< std::string, std::string > NamedItem
Public type definitions.
Definition: IFileCatalog.h:37
Gaudi::IFileCatalog::Files
std::vector< NamedItem > Files
Definition: IFileCatalog.h:39
Gaudi::IFileCatalog::Strings
std::vector< std::string > Strings
Definition: IFileCatalog.h:40
std::string
STL class.
Gaudi::IFileCatalog::Attributes
std::vector< NamedItem > Attributes
Definition: IFileCatalog.h:38
DeclareInterfaceID
#define DeclareInterfaceID(iface, major, minor)
Macro to declare the interface ID when using the new mechanism of extending and implementing interfac...
Definition: IInterface.h:13
IInterface
Definition of the basic interface.
Definition: IInterface.h:277
IMessageSvc
The IMessage is the interface implemented by the message service.
Definition: IMessageSvc.h:38
Gaudi::IFileCatalog
File catalog interface.
Definition: IFileCatalog.h:27
Gaudi::IFileCatalog::Factory
Gaudi::PluginService::Factory< IInterface *(const std::string &, IMessageSvc *)> Factory
Definition: IFileCatalog.h:34
GaudiSvc.getMetaData
def getMetaData(path)
Definition: __init__.py:1
PluginService.h
std::vector
STL class.
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:104
IInterface.h
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1