#include <StorageSvc/DbContainer.h>

Inheritance diagram for pool::DbContainer:

Collaboration diagram for pool::DbContainer:

Public Member Functions
	DbContainer (const DbType &typ=POOL_StorageType)
	Constructor with initializing arguments. More...

	DbContainer (const DbContainer &c)
	Copy constructor. More...

	DbContainer (DbContainerObj *ptr)
	Constructor taking transient object. More...

virtual	~DbContainer ()
	Standard Destructor. More...

DbContainer &	operator= (const DbContainer &copy)
	Assignment operator. More...

DbContainer &	operator= (const int)
	Assignment operator to reset the handle easily using 0. More...

int	refCount () const
	Access reference counter. More...

const std::string &	name () const
	Name of the container the handle is supposed to point to. More...

DbAccessMode	openMode () const
	Mode of the handle (READ,WRITE,...) More...

uint64_t	size ()
	Access to the size of the container. More...

DbDatabase &	containedIn ()
	Access to the Database the container resides in. More...

const IDbContainer *	info () const
	Let the implementation access the internals. More...

IDbContainer *	info ()

const DbTypeInfo *	objectShape (const Guid &nam)
	Retrieve persistent type information by name. More...

const Token *	token () const
	Access the token of the container object. More...

DbStatus	close ()
	Close the container the handle points to. More...

DbStatus	open (DbDatabase &dbH, const std::string &nam, const DbTypeInfo *typ, const DbType &dbtyp, DbAccessMode mod)
	Open the container residing in <file> with given name and access mode. More...

DbStatus	checkAccess (DbDatabase &dbH, const std::string &nam, const DbType &dbtyp)
	Check if we can access the residing in <file> container for reading with the given type. More...

bool	isOpen () const
	Check if the container was opened. More...

DbStatus	transAct (Transaction::Action action)
	Execute Database Transaction Action. More...

DbStatus	setOption (const DbOption &refOpt)
	Pass options to the implementation. More...

DbStatus	getOption (DbOption &refOpt)
	Access options. More...

DbStatus	select (DbSelect &sel)
	Access objects through select staements. More...

DbStatus	fetch (DbSelect &sel)
	Fetch next object address of the selection to set token. More...

DbStatus	allocate (const void *object, ShapeH shape, Token::OID_t &oid)
	Access objects using pointer and shape. More...

DbStatus	save (const void *object, ShapeH shape, Token::OID_t &linkH)
	Save new object in the container and return its handle. More...

DbStatus	load (void **ptr, ShapeH shape, const Token::OID_t &lH)
	Select object in the container identified by its handle. More...

void *	allocate (unsigned long siz, const DbTypeInfo *typ)
	Access objects by handle directly. More...

DbStatus	free (void *ptr)
	In place free of raw memory. More...

template<class T >
DbStatus	remove (const DbObjectHandle< T > &objH)
	Remove the transient representation of the object from memory. More...

template<class T >
DbStatus	save (DbObjectHandle< T > &objH, const DbTypeInfo *typ)
	Add an object to the container identified by its handle. More...

template<class T >
DbStatus	load (DbObjectHandle< T > &objH, const Token::OID_t &linkH, const DbTypeInfo *typ)
	Load object in the container identified by its handle. More...

template<class T >
DbStatus	loadNext (DbObjectHandle< T > &objH, Token::OID_t &linkH, const DbTypeInfo *typ)
	Load object in the container identified by its handle. More...

DbContainerObj *	operator-> ()
	Dereference operator. More...

const DbContainerObj *	operator-> () const

bool	operator! () const
	Validity check through operator NOT. More...

const DbContainerObj *	ptr () const
	Access to underlying object. More...

DbContainerObj *	ptr ()

bool	isValid () const
	Validity check (Objy like) More...

const DbType &	type () const
	Inquire storage type of the handle. More...

Protected Types
typedef DbContainerObj	_DataType
	Data type definition. More...

typedef DbHandleBase< _DataType >	Base
	Data type definition. More...

Protected Member Functions
void	setType (const DbType &typ)
	Set handle type. More...

void	setPtr (DbContainerObj *ptr)
	Set data pointer. More...

Protected Attributes
DbContainerObj *	m_ptr
	Data member: Object pointer. Sub-classes need access on re-assignment. More...

DbType	m_type
	Data member: Technology type. Sub-classes need access on re-assignment. More...

Private Member Functions
void	switchPtr (DbContainerObj *obj)
	Assign transient object properly (including reference counting) More...

DbStatus	_load (DbObjectHandle< DbObject > &objH, const Token::OID_t &linkH, const DbTypeInfo *typ, bool any_next)
	Load object in the container identified by its link handle. More...

DbStatus	_loadNext (DbObjectHandle< DbObject > &objH, Token::OID_t &linkH, const DbTypeInfo *typ)
	Load next object in the container identified by its link handle. More...

DbStatus	_save (DbObjectHandle< DbObject > &objH, const DbTypeInfo *typ)
	Internal add of an object entry identified by its handle. More...

DbStatus	_remove (DbObjectHandle< DbObject > &objH)
	Remove the transient representation of the object from memory. More...

Detailed Description

Description: Definition of the object describing a database container Handle managing a DbContainerObj, which is a container of persistent objects.

Author: M.Frank

Version: 1.0

Definition at line 48 of file DbContainer.h.

Member Typedef Documentation

◆ _DataType

typedef DbContainerObj pool::DbHandleBase< DbContainerObj >::_DataType

protectedinherited

Data type definition.

Definition at line 34 of file DbHandleBase.h.

◆ Base

typedef DbHandleBase<_DataType> pool::DbHandleBase< DbContainerObj >::Base

protectedinherited

Data type definition.

Definition at line 36 of file DbHandleBase.h.

Constructor & Destructor Documentation

◆ DbContainer() [1/3]

pool::DbContainer::DbContainer ( const DbType & typ = POOL_StorageType )

inlineexplicit

Constructor with initializing arguments.

Definition at line 69 of file DbContainer.h.

69 { m_type=typ; }

◆ DbContainer() [2/3]

pool::DbContainer::DbContainer ( const DbContainer & c )

inline

Copy constructor.

Definition at line 71 of file DbContainer.h.

71 : Base() { switchPtr(c.m_ptr); }

◆ DbContainer() [3/3]

pool::DbContainer::DbContainer ( DbContainerObj * ptr )

inline

Constructor taking transient object.

Definition at line 73 of file DbContainer.h.

73 { switchPtr(ptr); }

◆ ~DbContainer()

virtual pool::DbContainer::~DbContainer ( )

inlinevirtual

Standard Destructor.

Definition at line 75 of file DbContainer.h.

75 { switchPtr(0); }

Member Function Documentation

◆ _load()

DbStatus pool::DbContainer::_load	(	DbObjectHandle< DbObject > &	objH,
		const Token::OID_t &	linkH,
		const DbTypeInfo *	typ,
		bool	any_next
	)

private

Load object in the container identified by its link handle.

◆ _loadNext()

DbStatus pool::DbContainer::_loadNext	(	DbObjectHandle< DbObject > &	objH,
		Token::OID_t &	linkH,
		const DbTypeInfo *	typ
	)

private

Load next object in the container identified by its link handle.

◆ _remove()

DbStatus pool::DbContainer::_remove ( DbObjectHandle< DbObject > & objH )

private

Remove the transient representation of the object from memory.

◆ _save()

DbStatus pool::DbContainer::_save	(	DbObjectHandle< DbObject > &	objH,
		const DbTypeInfo *	typ
	)

private

Internal add of an object entry identified by its handle.

◆ allocate() [1/2]

DbStatus pool::DbContainer::allocate	(	const void *	object,
		ShapeH	shape,
		Token::OID_t &	oid
	)

Access objects using pointer and shape.

In place allocation of object location

◆ allocate() [2/2]

void* pool::DbContainer::allocate	(	unsigned long	siz,
		const DbTypeInfo *	typ
	)

Access objects by handle directly.

This is the generic "direct" object access. In place allocation of raw memory

◆ checkAccess()

DbStatus pool::DbContainer::checkAccess	(	DbDatabase &	dbH,
		const std::string &	nam,
		const DbType &	dbtyp
	)

Check if we can access the residing in <file> container for reading with the given type.

Parameters

dbH	[IN] Valid handle to database object
nam	[IN] Name of the container to be opened.
dbtyp	[IN] Database type (including minor type)

Returns: Status code indicating success or failure.

◆ close()

DbStatus pool::DbContainer::close ( )

Close the container the handle points to.

◆ containedIn()

DbDatabase& pool::DbContainer::containedIn ( )

Access to the Database the container resides in.

◆ fetch()

DbStatus pool::DbContainer::fetch ( DbSelect & sel )

Fetch next object address of the selection to set token.

◆ free()

DbStatus pool::DbContainer::free ( void * ptr )

In place free of raw memory.

◆ getOption()

DbStatus pool::DbContainer::getOption ( DbOption & refOpt )

Access options.

◆ info() [1/2]

IDbContainer* pool::DbContainer::info ( )

◆ info() [2/2]

const IDbContainer* pool::DbContainer::info ( ) const

Let the implementation access the internals.

◆ isOpen()

bool pool::DbContainer::isOpen ( ) const

Check if the container was opened.

◆ isValid()

bool pool::DbHandleBase< DbContainerObj >::isValid

inlineinherited

Validity check (Objy like)

Definition at line 68 of file DbHandleBase.h.

68 { return 0 != m_ptr; }

◆ load() [1/2]

template<class T >

DbStatus pool::DbContainer::load	(	DbObjectHandle< T > &	objH,
		const Token::OID_t &	linkH,
		const DbTypeInfo *	typ
	)

inline

Load object in the container identified by its handle.

Definition at line 184 of file DbContainer.h.

187 { return _load(objH, linkH, typ, false); }

◆ load() [2/2]

DbStatus pool::DbContainer::load	(	void **	ptr,
		ShapeH	shape,
		const Token::OID_t &	lH
	)

Select object in the container identified by its handle.

◆ loadNext()

template<class T >

DbStatus pool::DbContainer::loadNext	(	DbObjectHandle< T > &	objH,
		Token::OID_t &	linkH,
		const DbTypeInfo *	typ
	)

inline

Load object in the container identified by its handle.

Definition at line 189 of file DbContainer.h.

192 { return _loadNext(objH, linkH, typ); }

◆ name()

const std::string& pool::DbContainer::name ( ) const

Name of the container the handle is supposed to point to.

◆ objectShape()

const DbTypeInfo* pool::DbContainer::objectShape ( const Guid & nam )

Retrieve persistent type information by name.

◆ open()

DbStatus pool::DbContainer::open	(	DbDatabase &	dbH,
		const std::string &	nam,
		const DbTypeInfo *	typ,
		const DbType &	dbtyp,
		DbAccessMode	mod
	)

Open the container residing in <file> with given name and access mode.

Parameters

dbH	[IN] Valid handle to database object
nam	[IN] Name of the container to be opened.
typ	[IN] Type information in the event the container must be created.
dbtyp	[IN] Database type (including minor type)
mod	[IN] Access mode.

Returns: Status code indicating success or failure.

◆ openMode()

DbAccessMode pool::DbContainer::openMode ( ) const

Mode of the handle (READ,WRITE,...)

◆ operator!()

bool pool::DbHandleBase< DbContainerObj >::operator!

inlineinherited

Validity check through operator NOT.

Definition at line 63 of file DbHandleBase.h.

63 { return !isValid(); }

◆ operator->() [1/2]

DbContainerObj * pool::DbHandleBase< DbContainerObj >::operator->

inlineinherited

Dereference operator.

Definition at line 60 of file DbHandleBase.h.

60 { return m_ptr; }

◆ operator->() [2/2]

const DbContainerObj * pool::DbHandleBase< DbContainerObj >::operator->

inlineinherited

Definition at line 61 of file DbHandleBase.h.

61 { return m_ptr; }

◆ operator=() [1/2]

DbContainer& pool::DbContainer::operator= ( const DbContainer & copy )

inline

Assignment operator.

Definition at line 77 of file DbContainer.h.

                                                     {
       if ( &copy != this )  {
         m_type = copy.m_type;
         switchPtr( copy.m_ptr );
       }
       return *this;
     }

◆ operator=() [2/2]

DbContainer& pool::DbContainer::operator= ( const int )

inline

Assignment operator to reset the handle easily using 0.

Definition at line 85 of file DbContainer.h.

                                          {
       switchPtr(0);
       return *this;
     }

◆ ptr() [1/2]

DbContainerObj * pool::DbHandleBase< DbContainerObj >::ptr

inlineinherited

Definition at line 66 of file DbHandleBase.h.

66 { return m_ptr; }

◆ ptr() [2/2]

const DbContainerObj * pool::DbHandleBase< DbContainerObj >::ptr

inlineinherited

Access to underlying object.

Definition at line 65 of file DbHandleBase.h.

65 { return m_ptr; }

◆ refCount()

int pool::DbContainer::refCount ( ) const

Access reference counter.

◆ remove()

template<class T >

DbStatus pool::DbContainer::remove ( const DbObjectHandle< T > & objH )

inline

Remove the transient representation of the object from memory.

Definition at line 177 of file DbContainer.h.

178 { DbObjectHandle<DbObject> oH(objH.ptr()); return _remove(oH); }

◆ save() [1/2]

DbStatus pool::DbContainer::save	(	const void *	object,
		ShapeH	shape,
		Token::OID_t &	linkH
	)

Save new object in the container and return its handle.

◆ save() [2/2]

template<class T >

DbStatus pool::DbContainer::save	(	DbObjectHandle< T > &	objH,
		const DbTypeInfo *	typ
	)

inline

Add an object to the container identified by its handle.

Definition at line 180 of file DbContainer.h.

182 { DbObjectHandle<DbObject> oH(objH.ptr()); return _save(oH, typ); }

◆ select()

DbStatus pool::DbContainer::select ( DbSelect & sel )

Access objects through select staements.

This access type is ideal for relational Databases. Other technologies only have very limited support for this interface. Perform selection. The statement belongs to the container afterwards.

◆ setOption()

DbStatus pool::DbContainer::setOption ( const DbOption & refOpt )

Pass options to the implementation.

◆ setPtr()

void pool::DbHandleBase< DbContainerObj >::setPtr ( DbContainerObj * ptr )

inlineprotectedinherited

Set data pointer.

Definition at line 56 of file DbHandleBase.h.

56 { m_ptr=ptr; }

◆ setType()

void pool::DbHandleBase< DbContainerObj >::setType ( const DbType & typ )

inlineprotectedinherited

Set handle type.

Definition at line 54 of file DbHandleBase.h.

54 { m_type=typ; }

◆ size()

uint64_t pool::DbContainer::size ( )

Access to the size of the container.

◆ switchPtr()

void pool::DbContainer::switchPtr ( DbContainerObj * obj )

private

Assign transient object properly (including reference counting)

◆ token()

const Token* pool::DbContainer::token ( ) const

Access the token of the container object.

◆ transAct()

DbStatus pool::DbContainer::transAct ( Transaction::Action action )

Execute Database Transaction Action.

◆ type()

const DbType& pool::DbHandleBase< DbContainerObj >::type

inlineinherited

Inquire storage type of the handle.

Definition at line 70 of file DbHandleBase.h.

70 { return m_type; }

Member Data Documentation

◆ m_ptr

DbContainerObj * pool::DbHandleBase< DbContainerObj >::m_ptr

protectedinherited

Data member: Object pointer. Sub-classes need access on re-assignment.

Definition at line 38 of file DbHandleBase.h.

◆ m_type

DbType pool::DbHandleBase< DbContainerObj >::m_type

protectedinherited

Data member: Technology type. Sub-classes need access on re-assignment.

Definition at line 40 of file DbHandleBase.h.

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

DbContainer.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ _DataType

◆ Base

Constructor & Destructor Documentation

◆ DbContainer() [1/3]

◆ DbContainer() [2/3]

◆ DbContainer() [3/3]

◆ ~DbContainer()

Member Function Documentation

◆ _load()

◆ _loadNext()

◆ _remove()

◆ _save()

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ checkAccess()

◆ close()

◆ containedIn()

◆ fetch()

◆ free()

◆ getOption()

◆ info() [1/2]

◆ info() [2/2]

◆ isOpen()

◆ isValid()

◆ load() [1/2]

◆ load() [2/2]

◆ loadNext()

◆ name()

◆ objectShape()

◆ open()

◆ openMode()

◆ operator!()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ptr() [1/2]

◆ ptr() [2/2]

◆ refCount()

◆ remove()

◆ save() [1/2]

◆ save() [2/2]

◆ select()

◆ setOption()

◆ setPtr()

◆ setType()

◆ size()

◆ switchPtr()

◆ token()

◆ transAct()

◆ type()

Member Data Documentation

◆ m_ptr

◆ m_type