This class constitutes the core of the XML based FileCatalog API for using POOL within Gaudi. More...

#include </builds/gaudi/Gaudi/GaudiUtils/src/component/MultiFileCatalog.h>

Inheritance diagram for Gaudi::MultiFileCatalog:

[legend]

Collaboration diagram for Gaudi::MultiFileCatalog:

[legend]

Public Types
typedef Service::Factory	Factory

Public Types inherited from extends< Service, IFileCatalog, IFileCatalogMgr >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Public Member Functions
StatusCode	initialize () override
	IService implementation.

StatusCode	finalize () override
	Finalize service object.

std::string	createFID () const override
	Catalog interface.

CSTR	connectInfo () const override
	Access to connect string.

void	init () override
	Parse the DOM tree of the XML catalog.

void	commit () override
	Save DOM catalog to file.

void	rollback () override
	Save DOM catalog to file.

bool	readOnly () const override
	Check if the catalog is read-only.

bool	dirty () const override
	Check if the catalog should be updated.

bool	existsPFN (CSTR pfn) const override
	Return the status of physical file name.

std::string	lookupPFN (CSTR pfn) const override
	Lookup file identifier by physical file name.

bool	existsLFN (CSTR lfn) const override
	Return the status of a logical file name.

std::string	lookupLFN (CSTR lfn) const override
	Lookup file identifier by logical file name.

bool	existsFID (CSTR fid) const override
	Return the status of a FileID.

void	getPFN (CSTR fid, Files &files) const override
	Dump all physical file names of the catalog and their attributes associate to the FileID.

void	getLFN (CSTR fid, Files &files) const override
	Dump all logical file names of the catalog associate to the FileID.

void	getFID (Strings &fids) const override
	Dump all file Identifiers.

void	deleteFID (CSTR fid) const override
	Delete FileID from the catalog.

void	registerPFN (CSTR fid, CSTR pfn, CSTR ftype) const override
	Create a FileID and DOM Node of the PFN with all the attributes.

void	registerLFN (CSTR fid, CSTR lfn) const override
	Create a FileID and DOM Node of the LFN with all the attributes.

void	registerFID (CSTR fid) const override
	Create a FileID and DOM Node.

void	renamePFN (CSTR pfn, CSTR newpfn) const override
	rename a PFN

void	deletePFN (CSTR pfn) const override
	remove a PFN

void	getMetaData (CSTR fid, Attributes &attr) const override
	Dump all MetaData of the catalog for a given file ID.

std::string	getMetaDataItem (CSTR fid, CSTR name) const override
	Access metadata item.

void	setMetaData (CSTR fid, CSTR attr, CSTR val) const override
	Insert/update metadata item.

void	dropMetaData (CSTR fid) const override
	Drop all metadata of one FID.

void	dropMetaData (CSTR fid, CSTR attr) const override
	Drop specified metadata item.

IFileCatalog *	findCatalog (CSTR connect, bool must_be_writable) const override
	Catalog management.

void	addCatalog (CSTR connect) override
	Add new catalog identified by name to the existing ones.

void	addCatalog (IFileCatalog *cat) override
	Add new catalog identified by reference to the existing ones.

void	removeCatalog (CSTR connect) override
	Remove catalog identified by name from the existing ones.

void	removeCatalog (const IFileCatalog *cat) override
	Remove catalog identified by reference from the existing ones.

Catalogs &	catalogs () override
	Access catalog container.

const Catalogs &	catalogs () const override
	Access catalog container (CONST)

IFileCatalog *	writeCatalog (CSTR fid="") const override
	Access to the (first) writable file catalog.

void	setWriteCatalog (IFileCatalog *cat) override
	Define the writable catalog identified by reference.

void	setWriteCatalog (CSTR connect) override
	Define the writable catalog identified by name.

Public Member Functions inherited from extends< Service, IFileCatalog, IFileCatalogMgr >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Protected Types
typedef const std::string &	CSTR

typedef std::vector< IFileCatalog * >	Catalogs

typedef std::vector< std::string >	CatalogNames

Protected Member Functions
template<class A1, class F>
std::string	_find (A1 &arg1, F pmf) const

template<class A1, class F>
void	_collect (A1 &arg1, F f) const

template<class A2, class A1, class F>
void	_collect (const A2 &arg2, A1 &arg1, F f) const

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Private Member Functions
IFileCatalog *	getCatalog (CSTR fid, bool throw_if_not, bool writable=true, bool prt=true) const
	Find catalog containing a given file identifier.

Catalogs::iterator	i_findCatalog (CSTR connect, bool must_be_writable)
	Find catalog by connect string.

void	propHandler ()
	simple property handle to allow interactive modification of list of the file catalogs

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

std::string	lookupFID (CSTR lfn) const

Private Attributes
Catalogs	m_catalogs
	Container with references to known catalogs.

Gaudi::Property< CatalogNames >	m_catalogNames

bool	m_started = false
	Flag to indicate if catalog is started.

CatalogNames	m_oldNames
	BACKUP:: Container with catalog names.

Additional Inherited Members
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

This class constitutes the core of the XML based FileCatalog API for using POOL within Gaudi.

This class manages multiple file catalogs.

Definition at line 29 of file MultiFileCatalog.h.

Member Typedef Documentation

◆ CatalogNames

typedef std::vector<std::string> Gaudi::MultiFileCatalog::CatalogNames

protected

Definition at line 37 of file MultiFileCatalog.h.

◆ Catalogs

typedef std::vector<IFileCatalog*> Gaudi::MultiFileCatalog::Catalogs

protected

Definition at line 36 of file MultiFileCatalog.h.

◆ CSTR

typedef const std::string& Gaudi::MultiFileCatalog::CSTR

protected

Definition at line 35 of file MultiFileCatalog.h.

◆ Factory

typedef Service::Factory Gaudi::MultiFileCatalog::Factory

Definition at line 32 of file MultiFileCatalog.h.

Member Function Documentation

◆ _collect() [1/2]

template<class A1, class F>

void Gaudi::MultiFileCatalog::_collect	(	A1 &	arg1,
		F	f ) const

inlineprotected

Definition at line 49 of file MultiFileCatalog.h.

                                         {
      A1 tmp;
      for ( const auto& i : m_catalogs ) {
        f( i, tmp ); // tmp = f(i)
        arg1.insert( arg1.end(), tmp.begin(), tmp.end() );
        tmp.clear();
      }
    }

◆ _collect() [2/2]

template<class A2, class A1, class F>

void Gaudi::MultiFileCatalog::_collect	(	const A2 &	arg2,
		A1 &	arg1,
		F	f ) const

inlineprotected

Definition at line 58 of file MultiFileCatalog.h.

                                                         {
      A1 tmp;
      for ( const auto& i : m_catalogs ) {
        f( i, arg2, tmp ); // tmp = f(i,arg2)
        arg1.insert( arg1.end(), tmp.begin(), tmp.end() );
        tmp.clear();
      }
    }

◆ _find()

template<class A1, class F>

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

inlineprotected

Definition at line 40 of file MultiFileCatalog.h.

                                             {
      std::string result;
      for ( const auto& i : m_catalogs ) {
        result = ( i->*pmf )( arg1 );
        if ( !result.empty() ) break;
      }
      return result;
    }

◆ addCatalog() [1/2]

void MultiFileCatalog::addCatalog ( CSTR connect )

override

Add new catalog identified by name to the existing ones.

Catalog is already present ... silently ignore request

Definition at line 100 of file MultiFileCatalog.cpp.

                                            {
  if ( !con.empty() ) {
    if ( !findCatalog( con, false ) ) {
      static const string xml_typ = "Gaudi::XMLFileCatalog";
      auto                id0     = con.find( "_" );
      string              typ     = con.substr( 0, id0 );
      string              url     = con.substr( id0 + 1 );
      IInterface*         cat     = nullptr;
      if ( strncasecmp( "xml", typ.c_str(), 3 ) == 0 ) {
        cat = IFileCatalog::Factory::create( xml_typ, url, msgSvc().get() ).release();
      } else {
        using Gaudi::PluginService::Details::Registry;
        Registry& registry = Registry::instance();
        if ( registry.getInfo( typ ).factory.type() == typeid( Service::Factory::FactoryType ) ) {
          cat = Service::Factory::create( typ, url, serviceLocator().get() ).release();
        } else if ( registry.getInfo( typ ).factory.type() == typeid( IFileCatalog::Factory::FactoryType ) ) {
          cat = IFileCatalog::Factory::create( typ, url, msgSvc().get() ).release();
        }
      }
      if ( cat ) {
        auto fileCat = SmartIF<IFileCatalog>( cat );
        if ( fileCat ) {
          addCatalog( fileCat.get() ); // addCatalog will take care of the refCount of fileCat...
          return;
        }
      }
      printError( "Failed to create catalog connection:" + con, true );
    }
    return;
  }
  printError( "Got invalid (empty) catalog connection string.", true );
}

◆ addCatalog() [2/2]

void MultiFileCatalog::addCatalog ( IFileCatalog * cat )

override

Add new catalog identified by reference to the existing ones.

Definition at line 134 of file MultiFileCatalog.cpp.

                                                     {
  if ( cat ) {
    cat->addRef();
    m_catalogs.push_back( cat );
    return;
  }
  printError( "Got invalid catalog to be added to multi catalog.", true );
}

◆ catalogs() [1/2]

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

inlineoverride

Access catalog container (CONST)

Definition at line 154 of file MultiFileCatalog.h.

154{ return m_catalogs; }

◆ catalogs() [2/2]

Catalogs & Gaudi::MultiFileCatalog::catalogs ( )

inlineoverride

Access catalog container.

Definition at line 152 of file MultiFileCatalog.h.

152{ return m_catalogs; }

◆ commit()

void MultiFileCatalog::commit ( )

override

Save DOM catalog to file.

Definition at line 227 of file MultiFileCatalog.cpp.

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

◆ connectInfo()

MultiFileCatalog::CSTR MultiFileCatalog::connectInfo ( ) const

override

Access to connect string.

Definition at line 61 of file MultiFileCatalog.cpp.

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

◆ createFID()

std::string MultiFileCatalog::createFID ( ) const

override

Catalog interface.

Create file identifier using UUID mechanism.

Create file identifier using UUID mechanism

Definition at line 59 of file MultiFileCatalog.cpp.

59{ return createGuidAsString(); }

Gaudi::createGuidAsString

std::string createGuidAsString()

Helper function creating file identifier using the UUID mechanism.

◆ deleteFID()

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

inlineoverride

Delete FileID from the catalog.

Definition at line 114 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::deleteFID

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

Delete FileID Node from the catalog.

Gaudi::MultiFileCatalog::writeCatalog

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

Access to the (first) writable file catalog.

Definition MultiFileCatalog.h:156

◆ deletePFN()

void Gaudi::MultiFileCatalog::deletePFN ( CSTR pfn ) const

inlineoverride

remove a PFN

Definition at line 124 of file MultiFileCatalog.h.

124{ writeCatalog()->deletePFN( pfn ); }

Gaudi::IFileCatalog::deletePFN

virtual void deletePFN(const std::string &pfn) const =0

remove a PFN

◆ dirty()

bool MultiFileCatalog::dirty ( ) const

override

Check if the catalog should be updated.

Definition at line 217 of file MultiFileCatalog.cpp.

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

◆ dropMetaData() [1/2]

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

inlineoverride

Drop all metadata of one FID.

Definition at line 136 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::dropMetaData

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

Drop all metadata of one FID.

◆ dropMetaData() [2/2]

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

inlineoverride

Drop specified metadata item.

Definition at line 138 of file MultiFileCatalog.h.

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

◆ existsFID()

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

inlineoverride

Return the status of a FileID.

Definition at line 101 of file MultiFileCatalog.h.

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

Gaudi::MultiFileCatalog::getCatalog

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:66

◆ existsLFN()

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

inlineoverride

Return the status of a logical file name.

Definition at line 97 of file MultiFileCatalog.h.

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

Gaudi::MultiFileCatalog::lookupLFN

std::string lookupLFN(CSTR lfn) const override

Lookup file identifier by logical file name.

Definition MultiFileCatalog.h:99

◆ existsPFN()

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

inlineoverride

Return the status of physical file name.

Definition at line 93 of file MultiFileCatalog.h.

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

Gaudi::MultiFileCatalog::lookupPFN

std::string lookupPFN(CSTR pfn) const override

Lookup file identifier by physical file name.

Definition MultiFileCatalog.h:95

◆ finalize()

StatusCode MultiFileCatalog::finalize ( )

override

Finalize service object.

Definition at line 50 of file MultiFileCatalog.cpp.

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

◆ findCatalog()

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

override

Catalog management.

Find catalog by connect string

Definition at line 79 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;
}

◆ getCatalog()

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 66 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;
}

◆ getFID()

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

inlineoverride

Dump all file Identifiers.

Definition at line 112 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::getFID

virtual void getFID(Strings &fids) const =0

Dump all file Identifiers.

Gaudi::MultiFileCatalog::_collect

void _collect(A1 &arg1, F f) const

Definition MultiFileCatalog.h:49

◆ getLFN()

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 107 of file MultiFileCatalog.h.

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

◆ getMetaData()

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

inlineoverride

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

Definition at line 126 of file MultiFileCatalog.h.

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

◆ getMetaDataItem()

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

override

Access metadata item.

Definition at line 191 of file MultiFileCatalog.cpp.

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

◆ getPFN()

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 103 of file MultiFileCatalog.h.

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

◆ i_findCatalog()

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

private

Find catalog by connect string.

Definition at line 85 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;
}

◆ init()

void MultiFileCatalog::init ( )

override

Parse the DOM tree of the XML catalog.

Definition at line 222 of file MultiFileCatalog.cpp.

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

◆ initialize()

StatusCode MultiFileCatalog::initialize ( )

override

IService implementation.

Finalize service object

Definition at line 33 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;
}

◆ lookupFID()

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

private

◆ lookupLFN()

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

inlineoverride

Lookup file identifier by logical file name.

Definition at line 99 of file MultiFileCatalog.h.

99{ 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:40

◆ lookupPFN()

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

inlineoverride

Lookup file identifier by physical file name.

Definition at line 95 of file MultiFileCatalog.h.

95{ 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.

◆ printError()

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

private

Definition at line 92 of file MultiFileCatalog.cpp.

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

◆ propHandler()

void MultiFileCatalog::propHandler ( )

private

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

Definition at line 235 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;
}

◆ readOnly()

bool MultiFileCatalog::readOnly ( ) const

override

Check if the catalog is read-only.

Definition at line 212 of file MultiFileCatalog.cpp.

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

◆ registerFID()

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

inlineoverride

Create a FileID and DOM Node.

Definition at line 120 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::registerFID

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

Create a Node for a FileID and DOM Node.

◆ registerLFN()

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 206 of file MultiFileCatalog.cpp.

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

◆ registerPFN()

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 200 of file MultiFileCatalog.cpp.

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

◆ removeCatalog() [1/2]

void MultiFileCatalog::removeCatalog ( const IFileCatalog * cat )

override

Remove catalog identified by reference from the existing ones.

Definition at line 152 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 );
}

◆ removeCatalog() [2/2]

void MultiFileCatalog::removeCatalog ( CSTR connect )

override

Remove catalog identified by name from the existing ones.

Definition at line 143 of file MultiFileCatalog.cpp.

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

◆ renamePFN()

void Gaudi::MultiFileCatalog::renamePFN	(	CSTR	pfn,
		CSTR	newpfn ) const

inlineoverride

rename a PFN

Definition at line 122 of file MultiFileCatalog.h.

122{ writeCatalog()->renamePFN( pfn, newpfn ); }

Gaudi::IFileCatalog::renamePFN

virtual void renamePFN(const std::string &pfn, const std::string &new_pfn) const =0

rename a PFN

◆ rollback()

void MultiFileCatalog::rollback ( )

override

Save DOM catalog to file.

Definition at line 231 of file MultiFileCatalog.cpp.

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

◆ setMetaData()

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

inlineoverride

Insert/update metadata item.

Definition at line 132 of file MultiFileCatalog.h.

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

◆ setWriteCatalog() [1/2]

void MultiFileCatalog::setWriteCatalog ( CSTR connect )

override

Define the writable catalog identified by name.

Definition at line 181 of file MultiFileCatalog.cpp.

                                                     {
  auto i = i_findCatalog( connect, true );
  if ( i == m_catalogs.end() ) {
    addCatalog( connect );
    setWriteCatalog( findCatalog( connect, true ) );
    return;
  }
  setWriteCatalog( *i );
}

◆ setWriteCatalog() [2/2]

void MultiFileCatalog::setWriteCatalog ( IFileCatalog * cat )

override

Define the writable catalog identified by reference.

Definition at line 165 of file MultiFileCatalog.cpp.

                                                          {
  if ( cat ) {
    if ( !cat->readOnly() ) {
      auto i = find( m_catalogs.begin(), m_catalogs.end(), cat );
      if ( i != m_catalogs.end() ) {
        m_catalogs.erase( i );
        m_catalogs.insert( m_catalogs.begin(), cat );
        return;
      }
      printError( "The catalog " + cat->connectInfo() + " is not known.", true );
    }
    printError( "The catalog " + cat->connectInfo() + " is not writable.", true );
  }
  printError( "Invalid file catalog.", true );
}

◆ writeCatalog()

IFileCatalog * Gaudi::MultiFileCatalog::writeCatalog ( CSTR fid = "" ) const

inlineoverride

Access to the (first) writable file catalog.

Definition at line 156 of file MultiFileCatalog.h.

156{ return getCatalog( fid, true, true, false ); }

Member Data Documentation

◆ m_catalogNames

Gaudi::Property<CatalogNames> Gaudi::MultiFileCatalog::m_catalogNames

private

Initial value:

{

this, "Catalogs", { { "xmlcatalog_file:test_catalog.xml" } }, &MultiFileCatalog::propHandler, "catalog names" }

Gaudi::MultiFileCatalog::propHandler

void propHandler()

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

Definition MultiFileCatalog.cpp:235

Definition at line 178 of file MultiFileCatalog.h.

178 {

179 this, "Catalogs", { { "xmlcatalog_file:test_catalog.xml" } }, &MultiFileCatalog::propHandler, "catalog names" };

◆ m_catalogs

Catalogs Gaudi::MultiFileCatalog::m_catalogs

private

Container with references to known catalogs.

Definition at line 176 of file MultiFileCatalog.h.

◆ m_oldNames

CatalogNames Gaudi::MultiFileCatalog::m_oldNames

private

BACKUP:: Container with catalog names.

Definition at line 184 of file MultiFileCatalog.h.

◆ m_started

bool Gaudi::MultiFileCatalog::m_started = false

private

Flag to indicate if catalog is started.

Definition at line 182 of file MultiFileCatalog.h.

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

GaudiUtils/src/component/MultiFileCatalog.h
GaudiUtils/src/component/MultiFileCatalog.cpp

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CatalogNames

◆ Catalogs

◆ CSTR

◆ Factory

Member Function Documentation

◆ _collect() [1/2]

◆ _collect() [2/2]

◆ _find()

◆ addCatalog() [1/2]

◆ addCatalog() [2/2]

◆ catalogs() [1/2]

◆ catalogs() [2/2]

◆ commit()

◆ connectInfo()

◆ createFID()

◆ deleteFID()

◆ deletePFN()

◆ dirty()

◆ dropMetaData() [1/2]

◆ dropMetaData() [2/2]

◆ existsFID()

◆ existsLFN()

◆ existsPFN()

◆ finalize()

◆ findCatalog()

◆ getCatalog()

◆ getFID()

◆ getLFN()

◆ getMetaData()

◆ getMetaDataItem()

◆ getPFN()

◆ i_findCatalog()

◆ init()

◆ initialize()

◆ lookupFID()

◆ lookupLFN()

◆ lookupPFN()

◆ printError()

◆ propHandler()

◆ readOnly()

◆ registerFID()

◆ registerLFN()

◆ registerPFN()

◆ removeCatalog() [1/2]

◆ removeCatalog() [2/2]

◆ renamePFN()

◆ rollback()

◆ setMetaData()

◆ setWriteCatalog() [1/2]

◆ setWriteCatalog() [2/2]

◆ writeCatalog()

Member Data Documentation

◆ m_catalogNames

◆ m_catalogs

◆ m_oldNames

◆ m_started