pool::IDatabase Class Reference

IDatabase is the base class for database objects. More...

#include <PoolSvc/IDatabase.h>

Inheritance diagram for pool::IDatabase:

Collaboration diagram for pool::IDatabase:

Public Member Functions
virtual	~IDatabase ()
	Empty destructor.
virtual void	connectForRead ()=0
	Connects explicitly to the database for read operations.
virtual void	connectForWrite ()=0
	Connects explicitly to the database for write/update operations.
virtual void	disconnect ()=0
	Disconnects from the database.
virtual Io::IoFlag	openMode () const =0
	Returns the opening mode. It can be used to check whether the database is connected.
virtual const std::string &	fid ()=0
	Returns the file identifier of this database.
virtual const std::string &	pfn ()=0
	Returns the physical file name of this database.
virtual bool	setTechnology (long technology)=0
	Sets the technology identifier for this database.
virtual std::vector< std::string >	containers ()=0
	Returns the names of the containers in this database.
virtual IContainer *	containerHandle (const std::string &name)=0
	Returns a pointer to a container object. The user acquires ownership of that object.
virtual FileDescriptor *	fileDescriptor ()=0
	Expose FileDescriptor object for the technology specific DB implementation.
virtual bool	attributeOfType (const std::string &attributeName, void *data, const std::type_info &typeInfo, const std::string &option)=0
	The method returning the attribute data given a name.
virtual bool	setAttributeOfType (const std::string &attributeName, const void *data, const std::type_info &typeInfo, const std::string &option)=0
	The method setting the attribute data given a name.

Detailed Description

IDatabase is the base class for database objects.

Definition at line 37 of file IDatabase.h.

Constructor & Destructor Documentation

~IDatabase()

virtual pool::IDatabase::~IDatabase ( )

inlinevirtual

Empty destructor.

Definition at line 40 of file IDatabase.h.

{};

Member Function Documentation

attributeOfType()

virtual bool pool::IDatabase::attributeOfType ( const std::string & attributeName, void * data, const std::type_info & typeInfo, const std::string & option )

pure virtual

The method returning the attribute data given a name.

Implemented in pool::UserDatabase.

connectForRead()

virtual void pool::IDatabase::connectForRead ( )

pure virtual

Connects explicitly to the database for read operations.

Implemented in pool::UserDatabase.

connectForWrite()

virtual void pool::IDatabase::connectForWrite ( )

pure virtual

Connects explicitly to the database for write/update operations.

Implemented in pool::UserDatabase.

containerHandle()

virtual IContainer * pool::IDatabase::containerHandle ( const std::string & name )

pure virtual

Returns a pointer to a container object. The user acquires ownership of that object.

Implemented in pool::UserDatabase.

containers()

virtual std::vector< std::string > pool::IDatabase::containers ( )

pure virtual

Returns the names of the containers in this database.

Implemented in pool::UserDatabase.

disconnect()

virtual void pool::IDatabase::disconnect ( )

pure virtual

Disconnects from the database.

Implemented in pool::UserDatabase.

fid()

virtual const std::string & pool::IDatabase::fid ( )

pure virtual

Returns the file identifier of this database.

Implemented in pool::UserDatabase.

fileDescriptor()

virtual FileDescriptor * pool::IDatabase::fileDescriptor ( )

pure virtual

Expose FileDescriptor object for the technology specific DB implementation.

Implemented in pool::UserDatabase.

openMode()

virtual Io::IoFlag pool::IDatabase::openMode ( ) const

pure virtual

Returns the opening mode. It can be used to check whether the database is connected.

Implemented in pool::UserDatabase.

pfn()

virtual const std::string & pool::IDatabase::pfn ( )

pure virtual

Returns the physical file name of this database.

Implemented in pool::UserDatabase.

setAttributeOfType()

virtual bool pool::IDatabase::setAttributeOfType ( const std::string & attributeName, const void * data, const std::type_info & typeInfo, const std::string & option )

pure virtual

The method setting the attribute data given a name.

Implemented in pool::UserDatabase.

setTechnology()

virtual bool pool::IDatabase::setTechnology ( long technology )

pure virtual

Sets the technology identifier for this database.

This can only be called for newly created databases before the connect method is called. Otherwise false is returned.

Implemented in pool::UserDatabase.

---

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

• IDatabase.h