The Gaudi Framework: Gaudi::MultiFileCatalog Class Reference

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:171

const Catalogs& Gaudi::MultiFileCatalog::catalogs ( ) const

inlineoverride

Access catalog container (CONST)

Definition at line 148 of file MultiFileCatalog.h.

148 { return m_catalogs; }

Gaudi::IFileCatalog::commit

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:171

void MultiFileCatalog::commit ( )

override

Save DOM catalog to file.

Definition at line 244 of file MultiFileCatalog.cpp.

245 { for_each(m_catalogs,[](IFileCatalog* i) { i->commit(); } ); }

virtual void commit()=0

Save catalog to file.

Gaudi::IFileCatalog::deleteFID

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:171

Gaudi::IFileCatalog

File catalog interface.

Definition: IFileCatalog.h:24

std::for_each

T for_each(T...args)

ana.i

list i

Definition: ana.py:128

MultiFileCatalog::CSTR MultiFileCatalog::connectInfo ( ) const

override

Access to connect string.

Definition at line 64 of file MultiFileCatalog.cpp.

                                                          {
   static const string s("MultiCatalog");
   return s;
 }

std::string MultiFileCatalog::createFID ( ) const

override

Catalog interface.

Create file identifier using UUID mechanism.

Create file identifier using UUID mechanism

Definition at line 60 of file MultiFileCatalog.cpp.

                                              {
   return createGuidAsString();
 }

void Gaudi::MultiFileCatalog::deleteFID ( CSTR fid ) const

inlineoverride

Delete FileID from the catalog.

Definition at line 110 of file MultiFileCatalog.h.

111 { writeCatalog(fid)->deleteFID(fid); }

virtual void deleteFID(const std::string &FileID) const =0

Delete FileID Node from the catalog.

Gaudi::IFileCatalog::dropMetaData

IFileCatalog * writeCatalog(CSTR fid="") const override

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:150

bool MultiFileCatalog::dirty ( ) const

override

Check if the catalog should be updated.

Definition at line 236 of file MultiFileCatalog.cpp.

 {  return std::any_of( std::begin(m_catalogs), std::end(m_catalogs), 
                        [](const IFileCatalog* i) { return i->dirty();} ) ; 
 }

void Gaudi::MultiFileCatalog::dropMetaData ( CSTR fid ) const

inlineoverride

Drop all metadata of one FID.

Definition at line 128 of file MultiFileCatalog.h.

129 { writeCatalog(fid)->dropMetaData(fid); }

virtual void dropMetaData(const std::string &fid) const =0

Drop all metadata of one FID.

Gaudi::IFileCatalog::dropMetaData

IFileCatalog * writeCatalog(CSTR fid="") const override

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:150

void Gaudi::MultiFileCatalog::dropMetaData	(	CSTR	fid,
		CSTR	attr
	)		const

inlineoverride

Drop specified metadata item.

Definition at line 131 of file MultiFileCatalog.h.

132 { writeCatalog(fid)->dropMetaData(fid,attr); }

virtual void dropMetaData(const std::string &fid) const =0

Drop all metadata of one FID.

Gaudi::MultiFileCatalog::getCatalog

IFileCatalog * writeCatalog(CSTR fid="") const override

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:150

bool Gaudi::MultiFileCatalog::existsFID ( CSTR fid ) const

inlineoverride

Return the status of a FileID.

Definition at line 97 of file MultiFileCatalog.h.

98 { return 0 != getCatalog(fid,false,false,false); }

IFileCatalog * getCatalog(CSTR fid, bool throw_if_not, bool writable=true, bool prt=true) const

Find catalog containing a given file identifier.

Definition: MultiFileCatalog.cpp:69

bool Gaudi::MultiFileCatalog::existsLFN ( CSTR lfn ) const

inlineoverride

Return the status of a logical file name.

Definition at line 91 of file MultiFileCatalog.h.

92 { return !lookupLFN(lfn).empty(); }

std::string::empty

T empty(T...args)

Gaudi::MultiFileCatalog::lookupLFN

std::string lookupLFN(CSTR lfn) const override

Lookup file identifier by logical file name.

Definition: MultiFileCatalog.h:94

bool Gaudi::MultiFileCatalog::existsPFN ( CSTR pfn ) const

inlineoverride

Return the status of physical file name.

Definition at line 85 of file MultiFileCatalog.h.

86 { return !lookupPFN(pfn).empty(); }

std::string::empty

T empty(T...args)

Gaudi::MultiFileCatalog::lookupPFN

std::string lookupPFN(CSTR pfn) const override

Lookup file identifier by physical file name.

Definition: MultiFileCatalog.h:88

StatusCode MultiFileCatalog::finalize ( )

override

Finalize service object.

Definition at line 51 of file MultiFileCatalog.cpp.

                                        {
   commit();
   for_each(m_catalogs, [](IFileCatalog* i) { i->release(); } );
   m_catalogs.clear();
   m_started = false;
   return Service::finalize();
 }

IFileCatalog * MultiFileCatalog::findCatalog	(	CSTR	connect,
		bool	must_be_writable
	)		const

override

Catalog management.

Find catalog by connect string

Definition at line 88 of file MultiFileCatalog.cpp.

                                                                                       {
   auto i = std::find_if(m_catalogs.begin(), m_catalogs.end(),
                         [&](const IFileCatalog* f){
                             return connect == f->connectInfo();
   } );
   return ( i!=m_catalogs.end() &&
            ( !must_be_writable || !(*i)->readOnly() ) ) ? *i : nullptr;
 }

IFileCatalog * MultiFileCatalog::getCatalog	(	CSTR	fid,
		bool	throw_if_not,
		bool	writable = `true`,
		bool	prt = `true`
	)		const

private

Find catalog containing a given file identifier.

Definition at line 69 of file MultiFileCatalog.cpp.

 {
   for( const auto& c : m_catalogs ) {
     if ( !c || ( writable && c->readOnly() )) continue;
     if ( fid.empty() || ( !fid.empty() && c->existsFID(fid) ) )
       return c;
   }
   if ( prt )  {
     printError("No writable file catalog found which contains FID:"+fid,throw_if_not);
   }
   else  {
     debug() << "No writable file catalog found which contains FID:" << fid << endmsg;
   }
   return nullptr;
 }

void Gaudi::MultiFileCatalog::getFID ( Strings & fids ) const

inlineoverride

Dump all file Identifiers.

Definition at line 107 of file MultiFileCatalog.h.

108 { _collect(fids,std::mem_fn(&IFileCatalog::getFID)); }

Gaudi::IFileCatalog::getFID

virtual void getFID(Strings &fids) const =0

Dump all file Identifiers.

void _collect(A1 &arg1, F f) const

Definition: MultiFileCatalog.h:41

T mem_fn(T...args)

void Gaudi::MultiFileCatalog::getLFN	(	CSTR	fid,
		Files &	files
	)		const

inlineoverride

Dump all logical file names of the catalog associate to the FileID.

Definition at line 103 of file MultiFileCatalog.h.

104 { _collect(fid,files,std::mem_fn(&IFileCatalog::getLFN)); }

Gaudi::IFileCatalog::getLFN

void _collect(A1 &arg1, F f) const

Definition: MultiFileCatalog.h:41

virtual void getLFN(const std::string &fid, Files &files) const =0

Dump all LFNames of the catalog associate to the FileID.

Gaudi::IFileCatalog::getMetaData

T mem_fn(T...args)

void Gaudi::MultiFileCatalog::getMetaData	(	CSTR	fid,
		Attributes &	attr
	)		const

inlineoverride

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

Definition at line 120 of file MultiFileCatalog.h.

121 { _collect(fid,attr,std::mem_fn(&IFileCatalog::getMetaData)); }

virtual void getMetaData(const std::string &fid, Attributes &attr) const =0

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

void _collect(A1 &arg1, F f) const

Definition: MultiFileCatalog.h:41

Gaudi::IFileCatalog::getPFN

T mem_fn(T...args)

string MultiFileCatalog::getMetaDataItem	(	CSTR	fid,
		CSTR	name
	)		const

override

Access metadata item.

Definition at line 210 of file MultiFileCatalog.cpp.

                                                                   {
   std::string result;
   for(const auto& i : m_catalogs ) {
     result = i->getMetaDataItem(fid,attr);
     if ( !result.empty() ) break;
   }
   return result;
 }

void Gaudi::MultiFileCatalog::getPFN	(	CSTR	fid,
		Files &	files
	)		const

inlineoverride

Dump all physical file names of the catalog and their attributes associate to the FileID.

Definition at line 100 of file MultiFileCatalog.h.

101 { _collect(fid,files,std::mem_fn(&IFileCatalog::getPFN)); }

virtual void getPFN(const std::string &fid, Files &files) const =0

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

void _collect(A1 &arg1, F f) const

Definition: MultiFileCatalog.h:41

Gaudi::MultiFileCatalog::m_started

T mem_fn(T...args)

MultiFileCatalog::Catalogs::iterator MultiFileCatalog::i_findCatalog	(	CSTR	connect,
		bool	must_be_writable
	)

private

Find catalog by connect string.

Definition at line 98 of file MultiFileCatalog.cpp.

                                                                     {
   auto i = std::find_if(m_catalogs.begin(), m_catalogs.end(),
                         [&](const IFileCatalog* f){
                             return connect == f->connectInfo();
   } );
   if ( i!=m_catalogs.end() && must_be_writable && (*i)->readOnly() ) {
       i = m_catalogs.end();
   }
   return i;
 }

void MultiFileCatalog::init ( )

override

Parse the DOM tree of the XML catalog.

Definition at line 241 of file MultiFileCatalog.cpp.

242 { for_each(m_catalogs,[](IFileCatalog* i) { i->init(); }); m_started=true; }

bool m_started

Flag to indicate if catalog is started.

Definition: MultiFileCatalog.h:175

Gaudi::IFileCatalog::init

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:171

Gaudi::IFileCatalog

File catalog interface.

Definition: IFileCatalog.h:24

virtual void init()=0

Parse the DOM tree of the XML catalog.

std::for_each

T for_each(T...args)

ana.i

list i

Definition: ana.py:128

StatusCode MultiFileCatalog::initialize ( )

override

IService implementation.

Finalize service object

Definition at line 31 of file MultiFileCatalog.cpp.

                                          {
   if ( !Service::initialize().isSuccess() )  {
     printError("Failed to initialize service base class.",false);
     return StatusCode::SUCCESS;
   }
   std::string current;
   try {
     for(const auto& i : m_catalogNames ) {
       current = i;
       addCatalog(i);
     }
     init();
     return StatusCode::SUCCESS;
   }
   catch(const std::exception& /* e */)  {
     printError("Cannot add file catalog:"+current,false);
   }
   return StatusCode::FAILURE;
 }

std::string Gaudi::MultiFileCatalog::lookupFID ( CSTR lfn ) const

private

std::string Gaudi::MultiFileCatalog::lookupLFN ( CSTR lfn ) const

inlineoverride

Lookup file identifier by logical file name.

Definition at line 94 of file MultiFileCatalog.h.

95 { return _find(lfn,&IFileCatalog::lookupLFN); }

Gaudi::IFileCatalog::lookupLFN

virtual std::string lookupLFN(const std::string &lfn) const =0

Lookup file identifier by physical file name.

Gaudi::MultiFileCatalog::_find

std::string _find(A1 &arg1, F pmf) const

Definition: MultiFileCatalog.h:33

std::string Gaudi::MultiFileCatalog::lookupPFN ( CSTR pfn ) const

inlineoverride

Lookup file identifier by physical file name.

Definition at line 88 of file MultiFileCatalog.h.

89 { return _find(pfn,&IFileCatalog::lookupPFN); }

Gaudi::IFileCatalog::lookupPFN

virtual std::string lookupPFN(const std::string &lfn) const =0

Lookup file identifier by physical file name.

Gaudi::MultiFileCatalog::_find

std::string _find(A1 &arg1, F pmf) const

Definition: MultiFileCatalog.h:33

void MultiFileCatalog::printError	(	CSTR	msg,
		bool	throw_exc = `true`
	)		const

private

Definition at line 109 of file MultiFileCatalog.cpp.

                                                                 {
   if ( rethrow )  {
     fatal() << msg << endmsg;
     throw runtime_error("Catalog> "+msg);
   }
   error() << msg << endmsg;
 }

void MultiFileCatalog::propHandler ( Property & )

private

simple property handle to allow interactive modification of list of the file catalogs

Definition at line 250 of file MultiFileCatalog.cpp.

 {
   // not yet initialized
   if ( !m_started ) { m_oldNames = m_catalogNames; return; } // RETURN
   // no real change - no action
   if ( m_catalogNames == m_oldNames ) { return; }
   m_oldNames = m_catalogNames ;
   // remove ALL catalogs
   removeCatalog("") ;
   // add new catalogs
   for ( const auto& inew : m_catalogNames ) addCatalog ( inew ) ;
   // start
   init() ;
   //
   debug()
       << "New catalogs to be used: "
       << Gaudi::Utils::toString ( m_catalogNames ) << endmsg ;
 }

bool MultiFileCatalog::readOnly ( ) const

override

Check if the catalog is read-only.

Definition at line 231 of file MultiFileCatalog.cpp.

 {  return std::all_of( std::begin(m_catalogs), std::end(m_catalogs), 
                        [](const IFileCatalog* i) { return i->readOnly(); } );
 }

void Gaudi::MultiFileCatalog::registerFID ( CSTR fid ) const

inlineoverride

Create a FileID and DOM Node.

Definition at line 117 of file MultiFileCatalog.h.

118 { writeCatalog()->registerFID(fid); }

Gaudi::IFileCatalog::registerFID

virtual void registerFID(const std::string &fid) const =0

Create a Node for a FileID and DOM Node.

IFileCatalog * writeCatalog(CSTR fid="") const override

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:150

void MultiFileCatalog::registerLFN	(	CSTR	fid,
		CSTR	lfn
	)		const

override

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

Definition at line 225 of file MultiFileCatalog.cpp.

                                                             {
   IFileCatalog* c = getCatalog(fid,false,true,false);
   if ( !c ) c = getCatalog("",true,true,true);
   c->registerLFN(fid, lfn);
 }

void MultiFileCatalog::registerPFN	(	CSTR	fid,
		CSTR	pfn,
		CSTR	ftype
	)		const

override

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

Definition at line 219 of file MultiFileCatalog.cpp.

                                                                        {
   IFileCatalog* c = getCatalog(fid,false,true,false);
   if ( !c ) c = getCatalog("",true,true,true);
   c->registerPFN(fid, pfn, ftype);
 }

void MultiFileCatalog::removeCatalog ( CSTR connect )

override

Remove catalog identified by name from the existing ones.

Definition at line 162 of file MultiFileCatalog.cpp.

                                               {
   if ( con.empty() || con == "*" )  {
     for_each(m_catalogs, [](IFileCatalog* i) { i->release(); } );
     m_catalogs.clear();
     return;
   }
   removeCatalog(findCatalog(con,false));
 }

void MultiFileCatalog::removeCatalog ( const IFileCatalog * cat )

override

Remove catalog identified by reference from the existing ones.

Definition at line 171 of file MultiFileCatalog.cpp.

                                                              {
   if ( cat )  {
     auto i=find(m_catalogs.begin(),m_catalogs.end(),cat);
     if ( i != m_catalogs.end() )  {
       (*i)->release();
       m_catalogs.erase(i);
       return;
     }
     printError("Unknown file catalog -- cannot be removed.",true);
   }
   printError("Invalid file catalog.",true);
 }

void MultiFileCatalog::rollback ( )

override

Save DOM catalog to file.

Definition at line 247 of file MultiFileCatalog.cpp.

248 { for_each(m_catalogs, [](IFileCatalog* i) { i->rollback(); } ); }

Gaudi::IFileCatalog::rollback

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:171

Gaudi::IFileCatalog

File catalog interface.

Definition: IFileCatalog.h:24

virtual void rollback()=0

Save catalog to file.

std::for_each

T for_each(T...args)

ana.i

list i

Definition: ana.py:128

void Gaudi::MultiFileCatalog::setMetaData	(	CSTR	fid,
		CSTR	attr,
		CSTR	val
	)		const

inlineoverride

Insert/update metadata item.

Definition at line 125 of file MultiFileCatalog.h.

126 { writeCatalog(fid)->setMetaData(fid,attr,val); }

Gaudi::IFileCatalog::setMetaData

virtual void setMetaData(const std::string &fid, const std::string &name, const std::string &value) const =0

Insert/update metadata item.