| The Gaudi Framework v32r1 (f65d50dc)

XMLFileCatalog.h
Go to the documentation of this file.
1 #ifndef GAUDIUTILS_XMLFILECATALOG_H
2 #define GAUDIUTILS_XMLFILECATALOG_H
3
4 #include "GaudiUtils/IFileCatalog.h"
5 #include "xercesc/dom/DOMDocument.hpp"
6 #include "xercesc/dom/DOMElement.hpp"
7 #include "xercesc/parsers/XercesDOMParser.hpp"
8 #include "xercesc/sax/ErrorHandler.hpp"
9
10 #include <memory>
11
12 // Forward declarations
13 class IMessageSvc;
14
15 /*
16 * Gaudi namespace declaration
17 */
18 namespace Gaudi {
19
27 class XMLFileCatalog : public implements<IFileCatalog> {
28 protected:
29 typedef const std::string& CSTR;
30
31 public:
33 XMLFileCatalog( CSTR url, IMessageSvc* m );
34
36 std::string createFID() const override;
39 CSTR connectInfo() const override { return m_file; }
41 void init() override;
43 void commit() override;
45 void rollback() override {
46 if ( dirty() ) init();
47 }
49 bool readOnly() const override { return m_rdOnly; }
51 bool dirty() const override { return m_update; }
53 bool existsPFN( CSTR pfn ) const override { return element( pfn, false ) != 0; }
55 std::string lookupPFN( CSTR fid ) const override { return lookupFID( fid ); }
57 bool existsLFN( CSTR lfn ) const override { return element( lfn, false ) != 0; }
59 std::string lookupLFN( CSTR lfn ) const override { return lookupFID( lfn ); }
61 bool existsFID( CSTR fid ) const override { return element( fid, false ) != 0; }
63 void getPFN( CSTR fid, Files& files ) const override;
65 void getLFN( CSTR fid, Files& files ) const override;
67 void getFID( Strings& fids ) const override;
69 void deleteFID( CSTR FileID ) const override;
71 void registerPFN( CSTR fid, CSTR pfn, CSTR ftype ) const override;
73 void registerLFN( CSTR fid, CSTR lfn ) const override;
75 void registerFID( CSTR fid ) const override;
77 void renamePFN( CSTR pfn, CSTR new_pfn ) const override;
79 void deletePFN( CSTR pfn ) const override;
81 void getMetaData( CSTR fid, Attributes& attr ) const override;
83 std::string getMetaDataItem( CSTR fid, CSTR name ) const override;
85 void setMetaData( CSTR fid, CSTR name, CSTR value ) const override;
87 void dropMetaData( CSTR fid ) const override { dropMetaData( fid, "*" ); }
89 void dropMetaData( CSTR fid, CSTR attr ) const override;
90
91 private:
92 xercesc::DOMDocument* getDoc( bool throw_if_no_exists = true ) const;
93 std::string getfile( bool create );
94 void printError( CSTR msg, bool throw_exc = true ) const;
95 std::string lookupFID( CSTR lfn ) const;
96 xercesc::DOMNode* element( CSTR fid, bool print_err = true ) const;
97 xercesc::DOMNode* child( xercesc::DOMNode* par, CSTR tag, CSTR attr = "", CSTR val = "" ) const;
98 std::pair<xercesc::DOMElement*, xercesc::DOMElement*> i_registerFID( CSTR fid ) const;
99 bool m_rdOnly = false;
100 mutable bool m_update = false;
101 xercesc::DOMDocument* m_doc = nullptr;
102 std::unique_ptr<xercesc::XercesDOMParser> m_parser;
103 std::unique_ptr<xercesc::ErrorHandler> m_errHdlr;
104 std::string m_file;
105 IMessageSvc* m_msgSvc;
106 };
108 std::string createGuidAsString();
109 } /* End namespace Gaudi */
110 #endif /* GAUDIUTILS_XMLFILECATALOG_H */
Gaudi::XMLFileCatalog::registerPFN
void registerPFN(CSTR fid, CSTR pfn, CSTR ftype) const override
Create a FileID and Node of the physical file name with all the attributes.
Definition: XMLFileCatalog.cpp:379
Gaudi::XMLFileCatalog::getMetaDataItem
std::string getMetaDataItem(CSTR fid, CSTR name) const override
Access metadata item.
Definition: XMLFileCatalog.cpp:286
Gaudi::XMLFileCatalog::m_file
std::string m_file
Definition: XMLFileCatalog.h:104
Gaudi::XMLFileCatalog::dirty
bool dirty() const override
Check if the catalog should be updated.
Definition: XMLFileCatalog.h:51
Gaudi::XMLFileCatalog::registerLFN
void registerLFN(CSTR fid, CSTR lfn) const override
Create a FileID and Node of the logical file name with all the attributes.
Definition: XMLFileCatalog.cpp:409
implements
Base class used to implement the interfaces.
Definition: implements.h:9
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:41
Gaudi::XMLFileCatalog::registerFID
void registerFID(CSTR fid) const override
Create a FileID and Node.
Definition: XMLFileCatalog.cpp:311
Gaudi::XMLFileCatalog::rollback
void rollback() override
Save DOM catalog to file.
Definition: XMLFileCatalog.h:45
Gaudi::XMLFileCatalog::getFID
void getFID(Strings &fids) const override
Dump all file Identifiers.
Definition: XMLFileCatalog.cpp:235
Gaudi::XMLFileCatalog::lookupPFN
std::string lookupPFN(CSTR fid) const override
Lookup file identifier by physical file name.
Definition: XMLFileCatalog.h:55
Gaudi::XMLFileCatalog::getMetaData
void getMetaData(CSTR fid, Attributes &attr) const override
Dump all MetaData of the catalog for a given file ID.
Definition: XMLFileCatalog.cpp:253
Gaudi::XMLFileCatalog::getfile
std::string getfile(bool create)
Definition: XMLFileCatalog.cpp:464
Gaudi::XMLFileCatalog::setMetaData
void setMetaData(CSTR fid, CSTR name, CSTR value) const override
Insert/update metadata item.
Definition: XMLFileCatalog.cpp:270
Gaudi::XMLFileCatalog::renamePFN
void renamePFN(CSTR pfn, CSTR new_pfn) const override
rename a PFN
Definition: XMLFileCatalog.cpp:320
Gaudi::XMLFileCatalog::lookupFID
std::string lookupFID(CSTR lfn) const
Definition: XMLFileCatalog.cpp:220
Gaudi::XMLFileCatalog::m_parser
std::unique_ptr< xercesc::XercesDOMParser > m_parser
Definition: XMLFileCatalog.h:102
Gaudi::XMLFileCatalog::dropMetaData
void dropMetaData(CSTR fid) const override
Drop all metadata of one FID.
Definition: XMLFileCatalog.h:87
Gaudi::XMLFileCatalog::existsFID
bool existsFID(CSTR fid) const override
Return the status of a FileID.
Definition: XMLFileCatalog.h:61
Gaudi::XMLFileCatalog::i_registerFID
std::pair< xercesc::DOMElement *, xercesc::DOMElement * > i_registerFID(CSTR fid) const
Definition: XMLFileCatalog.cpp:343
std::string
STL class.
Gaudi::XMLFileCatalog::CSTR
const std::string & CSTR
Definition: XMLFileCatalog.h:29
compareOutputFiles.par
string par
Definition: compareOutputFiles.py:465
Gaudi::XMLFileCatalog::getLFN
void getLFN(CSTR fid, Files &files) const override
Dump all logical file names of the catalog associate to the FileID.
Definition: XMLFileCatalog.cpp:247
Gaudi::XMLFileCatalog::deletePFN
void deletePFN(CSTR pfn) const override
remove a PFN
Definition: XMLFileCatalog.cpp:328
Gaudi::XMLFileCatalog::lookupLFN
std::string lookupLFN(CSTR lfn) const override
Lookup file identifier by logical file name.
Definition: XMLFileCatalog.h:59
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:92
Gaudi::XMLFileCatalog::m_errHdlr
std::unique_ptr< xercesc::ErrorHandler > m_errHdlr
Definition: XMLFileCatalog.h:103
IMessageSvc
The IMessage is the interface implemented by the message service.
Definition: IMessageSvc.h:37
Gaudi::XMLFileCatalog::m_doc
xercesc::DOMDocument * m_doc
Definition: XMLFileCatalog.h:101
Gaudi::XMLFileCatalog::getPFN
void getPFN(CSTR fid, Files &files) const override
Dump all physical file names of the catalog and their attributes associate to the FileID.
Definition: XMLFileCatalog.cpp:241
IFileCatalog.h
Gaudi::XMLFileCatalog::connectInfo
CSTR connectInfo() const override
Access to connect string.
Definition: XMLFileCatalog.h:39
Gaudi::XMLFileCatalog::XMLFileCatalog
XMLFileCatalog(CSTR url, IMessageSvc *m)
Create a catalog file, initialization of XercesC.
Definition: XMLFileCatalog.cpp:179
Gaudi::XMLFileCatalog::m_rdOnly
bool m_rdOnly
Definition: XMLFileCatalog.h:99
std::pair
Gaudi::XMLFileCatalog::existsPFN
bool existsPFN(CSTR pfn) const override
Return the status of a physical file name.
Definition: XMLFileCatalog.h:53
std::unique_ptr< xercesc::XercesDOMParser >
Gaudi::createGuidAsString
std::string createGuidAsString()
Helper function creating file identifier using the UUID mechanism.
Gaudi::XMLFileCatalog::readOnly
bool readOnly() const override
Check if the catalog is read-only.
Definition: XMLFileCatalog.h:49
Gaudi::XMLFileCatalog::deleteFID
void deleteFID(CSTR FileID) const override
Delete FileID Node from the catalog.
Definition: XMLFileCatalog.cpp:305
Gaudi::XMLFileCatalog::createFID
std::string createFID() const override
Catalog interface.
Definition: XMLFileCatalog.cpp:182
Gaudi::XMLFileCatalog::commit
void commit() override
Save DOM catalog to file.
Definition: XMLFileCatalog.cpp:437
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:8
Gaudi::XMLFileCatalog::getDoc
xercesc::DOMDocument * getDoc(bool throw_if_no_exists=true) const
Definition: XMLFileCatalog.cpp:184
Gaudi::XMLFileCatalog::child
xercesc::DOMNode * child(xercesc::DOMNode *par, CSTR tag, CSTR attr="", CSTR val="") const
Definition: XMLFileCatalog.cpp:260
Gaudi::XMLFileCatalog::init
void init() override
Parse the DOM tree of the XML catalog.
Definition: XMLFileCatalog.cpp:195
Gaudi::XMLFileCatalog::element
xercesc::DOMNode * element(CSTR fid, bool print_err=true) const
Definition: XMLFileCatalog.cpp:299
Gaudi::XMLFileCatalog::m_msgSvc
IMessageSvc * m_msgSvc
Definition: XMLFileCatalog.h:105
Gaudi::XMLFileCatalog::existsLFN
bool existsLFN(CSTR lfn) const override
Return the status of a logical file name.
Definition: XMLFileCatalog.h:57
Gaudi::XMLFileCatalog
This class constitutes the core of the XML based FileCatalog API for POOL.
Definition: XMLFileCatalog.h:27
Gaudi::XMLFileCatalog::m_update
bool m_update
Definition: XMLFileCatalog.h:100
Gaudi
Header file for std:chrono::duration-based Counters.
Definition: __init__.py:1
Gaudi::XMLFileCatalog::printError
void printError(CSTR msg, bool throw_exc=true) const
Definition: XMLFileCatalog.cpp:189