| The Gaudi Framework v29r0 (ff2e7097)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | List of all members
Gaudi::IFileCatalog Class Referenceabstract

File catalog interface. More...

`#include <GaudiUtils/IFileCatalog.h>`

Inheritance diagram for Gaudi::IFileCatalog:
[legend]
Collaboration diagram for Gaudi::IFileCatalog:
[legend]

## Public Types
typedef Gaudi::PluginService::Factory< IInterface *, const std::string &, IMessageSvc * > | Factory
typedef std::pair< std::string, std::string > | NamedItem
| Public type definitions. More...
typedef std::vector< NamedItem > | Attributes
typedef std::vector< NamedItem > | Files
typedef std::vector< std::string > | Strings
Public Types inherited from IInterface
enum | Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
| Return status. More...
using | iid = Gaudi::InterfaceId< IInterface, 0, 0 >
| Interface ID. More...
using | ext_iids = Gaudi::interface_list< iid >
| Extra interfaces. More...

## Public Member Functions
| DeclareInterfaceID (IFileCatalog, 2, 0)
| InterfaceID. More...
virtual std::string | createFID () const =0
| Catalog interface. More...
virtual const std::string & | connectInfo () const =0
| Access to connect string. More...
virtual void | init ()=0
| Parse the DOM tree of the XML catalog. More...
virtual void | commit ()=0
| Save catalog to file. More...
virtual void | rollback ()=0
| Save catalog to file. More...
virtual bool | readOnly () const =0
| Check if the catalog is read-only. More...
virtual bool | dirty () const =0
| Check if the catalog should be updated. More...
virtual void | getPFN (const std::string &fid, Files &files) const =0
| Dump all PFNames of the catalog and their attributes associate to the FileID. More...
virtual void | getLFN (const std::string &fid, Files &files) const =0
| Dump all LFNames of the catalog associate to the FileID. More...
virtual void | getFID (Strings &fids) const =0
| Dump all file Identifiers. More...
virtual bool | existsPFN (const std::string &pfn) const =0
| Return the status of a PFName. More...
virtual std::string | lookupPFN (const std::string &lfn) const =0
| Lookup file identifier by physical file name. More...
virtual bool | existsLFN (const std::string &lfn) const =0
| Return the status of a LFName. More...
virtual std::string | lookupLFN (const std::string &lfn) const =0
| Lookup file identifier by physical file name. More...
virtual bool | existsFID (const std::string &fid) const =0
| Return the status of a FileID. More...
virtual void | deleteFID (const std::string &FileID) const =0
| Delete FileID Node from the catalog. More...
virtual void | registerPFN (const std::string &fid, const std::string &pfn, const std::string &ftype) const =0
| Create a Node for a FileID and DOM Node of the PFN with all the attributes. More...
virtual void | registerLFN (const std::string &fid, const std::string &lfn) const =0
| Create a Node for a FileID and DOM Node of the LFN with all the attributes. More...
virtual void | registerFID (const std::string &fid) const =0
| Create a Node for a FileID and DOM Node. More...
virtual void | getMetaData (const std::string &fid, Attributes &attr) const =0
| Dump all MetaData of the catalog for a given file ID. More...
virtual std::string | getMetaDataItem (const std::string &fid, const std::string &name) const =0
| Access metadata item. More...
virtual void | setMetaData (const std::string &fid, const std::string &name, const std::string &value) const =0
| Insert/update metadata item. More...
virtual void | dropMetaData (const std::string &fid) const =0
| Drop all metadata of one FID. More...
virtual void | dropMetaData (const std::string &fid, const std::string &attr) const =0
| Drop specified metadata item. More...
Public Member Functions inherited from IInterface
virtual void * | i_cast (const InterfaceID &) const =0
| main cast function More...
virtual std::vector< std::string > | getInterfaceNames () const =0
| Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long | addRef ()=0
| Increment the reference count of Interface instance. More...
virtual unsigned long | release ()=0
| Release Interface instance. More...
virtual unsigned long | refCount () const =0
| Current reference count. More...
virtual StatusCode | queryInterface (const InterfaceID &ti, void **pp)=0
| Set the void** to the pointer to the requested interface of the instance. More...
virtual | ~IInterface ()=default
| Virtual destructor. More...

## Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID & | interfaceID ()
| Return an instance of InterfaceID identifying the interface. More...

## Detailed Description

File catalog interface.

Resolve file ids, physical and logical file names.

Author
  M.Frank

Version
  1.0

Date
  20/10/2007

Definition at line 25 of file IFileCatalog.h.

## Member Typedef Documentation

typedef std::vector<NamedItem> Gaudi::IFileCatalog::Attributes

Definition at line 38 of file IFileCatalog.h.

typedef Gaudi::PluginService::Factory<IInterface*, const std::string&, IMessageSvc*> Gaudi::IFileCatalog::Factory

Definition at line 33 of file IFileCatalog.h.

typedef std::vector<NamedItem> Gaudi::IFileCatalog::Files

Definition at line 39 of file IFileCatalog.h.

typedef std::pair<std::string, std::string> Gaudi::IFileCatalog::NamedItem

Public type definitions.

Definition at line 37 of file IFileCatalog.h.

typedef std::vector<std::string> Gaudi::IFileCatalog::Strings

Definition at line 40 of file IFileCatalog.h.

## Member Function Documentation

virtual void Gaudi::IFileCatalog::commit | ( |  | ) |
| pure virtual

Save catalog to file.

virtual const std::string& Gaudi::IFileCatalog::connectInfo | ( |  | ) | const
| pure virtual

Access to connect string.

virtual std::string Gaudi::IFileCatalog::createFID | ( |  | ) | const
| pure virtual

Catalog interface.

Create file identifier using UUID mechanism

Gaudi::IFileCatalog::DeclareInterfaceID | ( | IFileCatalog | ,
|  | 2 | ,
|  | 0 |
| ) |  |

InterfaceID.

virtual void Gaudi::IFileCatalog::deleteFID | ( | const std::string & | FileID | ) | const
| pure virtual

Delete FileID Node from the catalog.

virtual bool Gaudi::IFileCatalog::dirty | ( |  | ) | const
| pure virtual

Check if the catalog should be updated.

virtual void Gaudi::IFileCatalog::dropMetaData | ( | const std::string & | fid | ) | const
| pure virtual

Drop all metadata of one FID.

virtual void Gaudi::IFileCatalog::dropMetaData | ( | const std::string & | fid,
|  | const std::string & | attr
| ) |  | const
| pure virtual

Drop specified metadata item.

virtual bool Gaudi::IFileCatalog::existsFID | ( | const std::string & | fid | ) | const
| pure virtual

Return the status of a FileID.

virtual bool Gaudi::IFileCatalog::existsLFN | ( | const std::string & | lfn | ) | const
| pure virtual

Return the status of a LFName.

virtual bool Gaudi::IFileCatalog::existsPFN | ( | const std::string & | pfn | ) | const
| pure virtual

Return the status of a PFName.

virtual void Gaudi::IFileCatalog::getFID | ( | Strings & | fids | ) | const
| pure virtual

Dump all file Identifiers.

virtual void Gaudi::IFileCatalog::getLFN | ( | const std::string & | fid,
|  | Files & | files
| ) |  | const
| pure virtual

Dump all LFNames of the catalog associate to the FileID.

virtual void Gaudi::IFileCatalog::getMetaData | ( | const std::string & | fid,
|  | Attributes & | attr
| ) |  | const
| pure virtual

Dump all MetaData of the catalog for a given file ID.

virtual std::string Gaudi::IFileCatalog::getMetaDataItem | ( | const std::string & | fid,
|  | const std::string & | name
| ) |  | const
| pure virtual

Access metadata item.

virtual void Gaudi::IFileCatalog::getPFN | ( | const std::string & | fid,
|  | Files & | files
| ) |  | const
| pure virtual

Dump all PFNames of the catalog and their attributes associate to the FileID.

virtual void Gaudi::IFileCatalog::init | ( |  | ) |
| pure virtual

Parse the DOM tree of the XML catalog.

virtual std::string Gaudi::IFileCatalog::lookupLFN | ( | const std::string & | lfn | ) | const
| pure virtual

Lookup file identifier by physical file name.

virtual std::string Gaudi::IFileCatalog::lookupPFN | ( | const std::string & | lfn | ) | const
| pure virtual

Lookup file identifier by physical file name.

virtual bool Gaudi::IFileCatalog::readOnly | ( |  | ) | const
| pure virtual

Check if the catalog is read-only.

virtual void Gaudi::IFileCatalog::registerFID | ( | const std::string & | fid | ) | const
| pure virtual

Create a Node for a FileID and DOM Node.

virtual void Gaudi::IFileCatalog::registerLFN | ( | const std::string & | fid,
|  | const std::string & | lfn
| ) |  | const
| pure virtual

Create a Node for a FileID and DOM Node of the LFN with all the attributes.

virtual void Gaudi::IFileCatalog::registerPFN | ( | const std::string & | fid,
|  | const std::string & | pfn,
|  | const std::string & | ftype
| ) |  | const
| pure virtual

Create a Node for a FileID and DOM Node of the PFN with all the attributes.

virtual void Gaudi::IFileCatalog::rollback | ( |  | ) |
| pure virtual

Save catalog to file.

virtual void Gaudi::IFileCatalog::setMetaData | ( | const std::string & | fid,
|  | const std::string & | name,
|  | const std::string & | value
| ) |  | const
| pure virtual

Insert/update metadata item.

The documentation for this class was generated from the following file:

- GaudiUtils/GaudiUtils/IFileCatalog.h