The Gaudi Framework: Gaudi::MultiFileCatalog Class Reference

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:170

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

inlinevirtual

Access catalog container (CONST)

Definition at line 147 of file MultiFileCatalog.h.

147 { return m_catalogs; }

Gaudi::IFileCatalog::commit

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:170

virtual void Gaudi::MultiFileCatalog::commit ( )

inlinevirtual

Save DOM catalog to file.

Definition at line 76 of file MultiFileCatalog.h.

76 { _exec(&IFileCatalog::commit); }

virtual void commit()=0

Save catalog to file.

Gaudi::MultiFileCatalog::_exec

void _exec(T pmf) const

Definition: MultiFileCatalog.h:31

MultiFileCatalog::CSTR MultiFileCatalog::connectInfo ( ) const

virtual

Access to connect string.

Definition at line 71 of file MultiFileCatalog.cpp.

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

std::string MultiFileCatalog::createFID ( ) const

virtual

Catalog interface.

Create file identifier using UUID mechanism.

Create file identifier using UUID mechanism

Definition at line 67 of file MultiFileCatalog.cpp.

                                              {
   return createGuidAsString();
 }

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

inlinevirtual

Delete FileID from the catalog.

Definition at line 109 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::deleteFID

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

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:149

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

Delete FileID Node from the catalog.

bool MultiFileCatalog::dirty ( ) const

virtual

Check if the catalog should be updated.

Definition at line 246 of file MultiFileCatalog.cpp.

247 { return _findX0Bool(m_catalogs,&IFileCatalog::dirty,true); }

Gaudi::IFileCatalog::dirty

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:170

virtual bool dirty() const =0

Check if the catalog should be updated.

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

inlinevirtual

Drop all metadata of one FID.

Definition at line 127 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::dropMetaData

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

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:149

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

Drop all metadata of one FID.

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

inlinevirtual

Drop specified metadata item.

Definition at line 130 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::dropMetaData

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

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:149

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

Drop all metadata of one FID.

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

inlinevirtual

Return the status of a FileID.

Definition at line 96 of file MultiFileCatalog.h.

97 { 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:76

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

inlinevirtual

Return the status of a logical file name.

Definition at line 90 of file MultiFileCatalog.h.

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

Gaudi::MultiFileCatalog::lookupLFN

virtual std::string lookupLFN(CSTR lfn) const

Lookup file identifier by logical file name.

Definition: MultiFileCatalog.h:93

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

inlinevirtual

Return the status of physical file name.

Definition at line 84 of file MultiFileCatalog.h.

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

Gaudi::MultiFileCatalog::lookupPFN

virtual std::string lookupPFN(CSTR pfn) const

Lookup file identifier by physical file name.

Definition: MultiFileCatalog.h:87

StatusCode MultiFileCatalog::finalize ( )

virtual

Finalize service object.

Reimplemented from Service.

Definition at line 58 of file MultiFileCatalog.cpp.

                                        {
   commit();
   _exec(&IFileCatalog::release);
   m_catalogs.clear();
   m_started = false;
   return Service::finalize();
 }

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

virtual

Catalog management.

Find catalog by connect string

Definition at line 102 of file MultiFileCatalog.cpp.

                                                                                       {
   for(Catalogs::const_iterator i=m_catalogs.begin(); i != m_catalogs.end(); ++i) {
     if ( connect == (*i)->connectInfo() )
       return (must_be_writable && (*i)->readOnly()) ? 0 : *i;
   }
   return 0;
 }

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

 {
   for(Catalogs::const_iterator i=m_catalogs.begin(); i != m_catalogs.end(); ++i)  {
     IFileCatalog* c = *i;
     if ( c )  {
       if ( writable && c->readOnly() )
         continue;
       else if ( fid.empty() )
         return c;
       else if ( !fid.empty() && c->existsFID(fid) )
         return c;
     }
   }
   if ( prt )  {
     printError("No writable file catalog found which contains FID:"+fid,throw_if_not);
   }
   else  {
     MsgStream log(msgSvc(),name());
     log << MSG::DEBUG << "No writable file catalog found which contains FID:" << fid << endmsg;
   }
   return 0;
 }

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

inlinevirtual

Dump all file Identifiers.

Definition at line 106 of file MultiFileCatalog.h.

107 { _collect(fids,&IFileCatalog::getFID); }

Gaudi::IFileCatalog::getFID

void _collect(A1 arg1, F pmf) const

Definition: MultiFileCatalog.h:41

virtual void getFID(Strings &fids) const =0

Dump all file Identifiers.

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

inlinevirtual

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

Definition at line 102 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::getLFN

void _collect(A1 arg1, F pmf) 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.

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

inlinevirtual

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

Definition at line 119 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::getMetaData

void _collect(A1 arg1, F pmf) const

Definition: MultiFileCatalog.h:41

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

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

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

virtual

Access metadata item.

Definition at line 224 of file MultiFileCatalog.cpp.

                                                                   {
   std::string result;
   for(Catalogs::const_iterator i=m_catalogs.begin(); i != m_catalogs.end(); ++i)
     if ( !(result= (*i)->getMetaDataItem(fid,attr)).empty() ) break;
   return result;
 }

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

inlinevirtual

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

Definition at line 99 of file MultiFileCatalog.h.

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

Gaudi::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.

Gaudi::MultiFileCatalog::m_started

void _collect(A1 arg1, F pmf) const

Definition: MultiFileCatalog.h:41

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

private

Find catalog by connect string.

Definition at line 111 of file MultiFileCatalog.cpp.

                                                                     {
   for(Catalogs::iterator i=m_catalogs.begin(); i != m_catalogs.end(); ++i) {
     if ( connect == (*i)->connectInfo() ) {
       return (must_be_writable && (*i)->readOnly()) ? m_catalogs.end() : i;
     }
   }
   return m_catalogs.end();
 }

virtual void Gaudi::MultiFileCatalog::init ( )

inlinevirtual

Parse the DOM tree of the XML catalog.

Definition at line 73 of file MultiFileCatalog.h.

74 { _exec(&IFileCatalog::init); m_started=true; }

bool m_started

Flag to indicate if catalog is started.

Definition: MultiFileCatalog.h:174

Gaudi::IFileCatalog::init

virtual void init()=0

Parse the DOM tree of the XML catalog.

Gaudi::MultiFileCatalog::_exec

void _exec(T pmf) const

Definition: MultiFileCatalog.h:31

StatusCode MultiFileCatalog::initialize ( )

virtual

IService implementation.

Finalize service object

Reimplemented from Service.

Definition at line 37 of file MultiFileCatalog.cpp.

                                          {
   CatalogNames::const_iterator i;
   std::string current = "";
   if ( !Service::initialize().isSuccess() )  {
     printError("Failed to initialize service base class.",false);
     return StatusCode::SUCCESS;
   }
   try {
     for(i=m_catalogNames.begin(); i != m_catalogNames.end(); ++i)  {
       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

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

inlinevirtual

Lookup file identifier by logical file name.

Definition at line 93 of file MultiFileCatalog.h.

94 { 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:35

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

inlinevirtual

Lookup file identifier by physical file name.

Definition at line 87 of file MultiFileCatalog.h.

88 { 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:35

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

private

Definition at line 120 of file MultiFileCatalog.cpp.

                                                                 {
   MsgStream log(msgSvc(),name());
   if ( rethrow )  {
     log << MSG::FATAL << msg << endmsg;
     throw runtime_error("Catalog> "+msg);
   }
   log << 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 249 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 ( CatalogNames::const_iterator inew = m_catalogNames.begin() ;
         m_catalogNames.end() != inew ; ++inew ) { addCatalog ( *inew ) ; }
   // start
   init() ;
   //
   MsgStream log ( msgSvc() , name() ) ;
   log << MSG::DEBUG
       << "New catalogs to be used: "
       << Gaudi::Utils::toString ( m_catalogNames ) << endmsg ;
 }

bool MultiFileCatalog::readOnly ( ) const

virtual

Check if the catalog is read-only.

Definition at line 243 of file MultiFileCatalog.cpp.

244 { return _findX0Bool(m_catalogs,&IFileCatalog::readOnly,false); }

Gaudi::IFileCatalog::readOnly

Catalogs m_catalogs

Container with references to known catalogs.

Definition: MultiFileCatalog.h:170

virtual bool readOnly() const =0

Check if the catalog is read-only.

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

inlinevirtual

Create a FileID and DOM Node.

Definition at line 116 of file MultiFileCatalog.h.

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

Gaudi::IFileCatalog::registerFID

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

Create a Node for a FileID and DOM Node.

Gaudi::IFileCatalog::rollback

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

Access to the (first) writable file catalog.

Definition: MultiFileCatalog.h:149

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

virtual

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

Definition at line 237 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

virtual

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

Definition at line 231 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 )

virtual

Remove catalog identified by name from the existing ones.

Definition at line 176 of file MultiFileCatalog.cpp.

                                               {
   if ( con.empty() || con == "*" )  {
     _exec(&IFileCatalog::release);
     m_catalogs.clear();
     return;
   }
   removeCatalog(findCatalog(con,false));
 }

void MultiFileCatalog::removeCatalog ( const IFileCatalog * cat )

virtual

Remove catalog identified by reference from the existing ones.

Definition at line 185 of file MultiFileCatalog.cpp.

                                                              {
   if ( cat )  {
     Catalogs::iterator 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);
 }

virtual void Gaudi::MultiFileCatalog::rollback ( )

inlinevirtual

Save DOM catalog to file.

Definition at line 78 of file MultiFileCatalog.h.

78 { _exec(&IFileCatalog::rollback); }

virtual void rollback()=0

Save catalog to file.

Gaudi::MultiFileCatalog::_exec

void _exec(T pmf) const

Definition: MultiFileCatalog.h:31

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

inlinevirtual

Insert/update metadata item.

Definition at line 124 of file MultiFileCatalog.h.

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