---

IOODataBase Class Reference

IOODataBase interface definition. More...

#include <IOODataBase.h>

Inheritance diagram for IOODataBase:

List of all members.

Public Types
typedef DbPersistent* (*	CreateP )( const dbHandle<DbContainer>& cntH )
	Functor to create persistent object.
typedef DbObject* (*	CreateT )( void* buffer)
	Functor to create transient object.
Public Methods
virtual StatusCode	initialize (const std::string& nam) = 0
	Initialize the database.
virtual StatusCode	finalize (void) = 0
	Initialize the database.
virtual IMessageSvc*	msgSvc () = 0
	Access to the message service.
virtual unsigned char	type () const = 0
	Access to technology type.
virtual const std::string&	name () const = 0
	Name of the database implementation.
virtual const std::string&	driver () const = 0
	Name of the driver's implementation.
virtual void	setDriver (const std::string& drv) = 0
	Set the name of the driver's implementation.
virtual const std::string&	server () const = 0
	Name of the database server host.
virtual void	setServer (const std::string& srv) = 0
	Set the name of the database server host.
virtual IDbSession*	createSession (void) = 0
	Create database session.
virtual IDbFederation*	createFederation (void) = 0
	create database federation.
virtual IDbDataBase*	createDataBase (void) = 0
	create database.
virtual IDbContainer*	createContainer (void) = 0
	create database container.
virtual const DbTypeInfo*	typeInfo (const std::string& nam) const = 0
	Request type information (CONST).
virtual DbTypeInfo*	typeInfo (const std::string& nam) = 0
	Request type information.
virtual DbResult	addTypeInfo (const std::string& nam, DbTypeInfo* info) = 0
	Add type information.
virtual DbTypeInfo*	addTypeInfo (const std::string& nam, const std::string& t_type, const std::string& p_type, const std::string& desc, std::vector<DbColumn*>& cols) = 0
	Create type information item for object binding.
virtual DbTypeInfo*	addTypeInfo (const IDbDataBase::Type* pType) = 0
	Create type information item for object binding.
virtual DbResult	prepareLink (const dbObjectHandle<DbObject>& objH, dbHandle<DbLink>& linkH, void* gene) = 0
	prepare link between objects in databases.
Static Public Methods
const InterfaceID&	interfaceID ()
	Retrieve interface ID. More...

---

Detailed Description

IOODataBase interface definition.

System: The LHCb Offline System

Package: DbCnv

The IOODataBase interface allows to:

• Create Database sessions.
• Create Database federations.
• Create Database files.
• Create Database containers.
• Create, delete and release Database objects.
• Attach type information of known objects to the database.
• Request type information from known objects in the database.
• Create and Update persistent Db objects from the transient store.
• Create and Update transient objects from their representations within Db.
• The Db conversion service also supports storage technology independent object linking. transient store.

Dependencies:

• Experiment Kernel definitions: "Gaudi/Kernel/Kernel.h"
• Return code class: "Gaudi/Kernel/StatusCode.h"
• Generic Interface definition: "Gaudi/Kernel/Interfaces/IInterface.h"

History:

   +---------+----------------------------------------------+---------
   |    Date |                 Comment                      | Who 
   +---------+----------------------------------------------+---------
   | 29/02/99| Initial version                              | MF
   +---------+----------------------------------------------+---------
    

Author(s):

Markus Frank

Version:

1.0

Definition at line 314 of file IOODataBase.h.

---

Member Typedef Documentation

typedef DbPersistent *(* IOODataBase::CreateP)(const dbHandle< DbContainer >&cntH)

Functor to create persistent object.

typedef DbObject *(* IOODataBase::CreateT)(void *buffer)

Functor to create transient object.

---

Member Function Documentation

DbTypeInfo * IOODataBase::addTypeInfo ( const IDbDataBase::Type * pType ) [pure virtual]

Create type information item for object binding. Reimplemented in OODataBaseImplementation.

DbTypeInfo * IOODataBase::addTypeInfo ( const std::string & nam, const std::string & t_type, const std::string & p_type, const std::string & desc, std::vector< DbColumn *>& cols ) [pure virtual]

Create type information item for object binding. Reimplemented in OODataBaseImplementation.

DbResult IOODataBase::addTypeInfo ( const std::string & name, DbTypeInfo * info ) [pure virtual]

Add type information. Reimplemented in OODataBaseImplementation.

IDbContainer * IOODataBase::createContainer ( void ) [pure virtual]

create database container. Referenced by DbContainer::DbContainer().

IDbDataBase * IOODataBase::createDataBase ( void ) [pure virtual]

create database.

IDbFederation * IOODataBase::createFederation ( void ) [pure virtual]

create database federation. Referenced by DbFederation::DbFederation().

IDbSession * IOODataBase::createSession ( void ) [pure virtual]

Create database session. Referenced by DbSession::open().

const std::string & IOODataBase::driver ( ) const [pure virtual]

Name of the driver's implementation. Reimplemented in OODataBaseImplementation. Referenced by DbImplementation::DbImplementation(), DbSession::close(), DbCnvSvc::initialize(), and DbSession::open().

StatusCode IOODataBase::finalize ( void ) [pure virtual]

Initialize the database. Reimplemented in OODataBaseImplementation.

StatusCode IOODataBase::initialize ( const std::string & name ) [pure virtual]

Initialize the database. Reimplemented in OODataBaseImplementation. Referenced by DbCnvSvc::initialize().

const InterfaceID & IOODataBase::interfaceID ( ) [inline, static]

Retrieve interface ID. Definition at line 317 of file IOODataBase.h.

IMessageSvc * IOODataBase::msgSvc ( ) [pure virtual]

Access to the message service. Reimplemented in OODataBaseImplementation.

const std::string & IOODataBase::name ( ) const [pure virtual]

Name of the database implementation. Reimplemented in OODataBaseImplementation. Referenced by DbBaseConverter::DbBaseConverter(), DbDataBase::DbDataBase(), DbDirectoryCnv::DbDirectoryCnv(), DbFederation::DbFederation(), DbSession::close(), DbSession::open(), and DbFederation::~DbFederation().

DbResult IOODataBase::prepareLink ( const dbObjectHandle< DbObject >& objH, dbHandle< DbLink >& linkH, void * gen ) [pure virtual]

prepare link between objects in databases. Reimplemented in OODataBaseImplementation.

const std::string & IOODataBase::server ( ) const [pure virtual]

Name of the database server host. Reimplemented in OODataBaseImplementation. Referenced by DbImplementation::DbImplementation().

void IOODataBase::setDriver ( const std::string & drv ) [pure virtual]

Set the name of the driver's implementation. Reimplemented in OODataBaseImplementation.

void IOODataBase::setServer ( const std::string & srv ) [pure virtual]

Set the name of the database server host. Reimplemented in OODataBaseImplementation.

unsigned char IOODataBase::type ( ) const [pure virtual]

Access to technology type. Reimplemented in OODataBaseImplementation. Referenced by DbCnvSvc::initialize().

DbTypeInfo * IOODataBase::typeInfo ( const std::string & name ) [pure virtual]

Request type information. Reimplemented in OODataBaseImplementation.

const DbTypeInfo * IOODataBase::typeInfo ( const std::string & name ) const [pure virtual]

Request type information (CONST). Reimplemented in OODataBaseImplementation. Referenced by DbBaseConverter::DbBaseConverter(), DbGenericConverter::DbGenericConverter(), DbDataBase::addAssocEntry(), and DbDataBase::addType().

---

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

• IOODataBase.h

---