pool::ImplicitCollection Class Reference

An implicit collection implementation of the ICollection interface. More...

#include <ImplicitCollection.h>

Inheritance diagram for pool::ImplicitCollection:

Collaboration diagram for pool::ImplicitCollection:

Public Types
typedef Gaudi::PluginService::Factory< ICollection *(const ICollectionDescription *, ICollection::OpenMode, ISession *)>	Factory
enum	OpenMode { CREATE, CREATE_AND_OVERWRITE, UPDATE, READ }
	Enumeration of the possible open modes of the collection. More...

Public Member Functions
	ImplicitCollection (ISession *session, const std::string &connection, const std::string &name, ICollection::OpenMode mode)
	Constructor - old style Throws POOL exception. More...
	ImplicitCollection (const ICollectionDescription *description, ICollection::OpenMode mode, ISession *session)
	Constructor compying to the new Collections API parameters as above, but name and connection passed in description. More...
	~ImplicitCollection ()
	Destructor. More...
	ImplicitCollection (const ImplicitCollection &)=delete
ImplicitCollection &	operator= (const ImplicitCollection &)=delete
virtual ICollection::OpenMode	openMode () const
	Return openMode. More...
ImplicitCollectionIterator *	select (const std::string &primaryQuery="", std::string secondaryQuery="", std::string options="")
	Method that returns collection's iterator Throws POOL exception. More...
void	commit (bool reopen=false)
	Commits the last changes made to the collection. Will always return true. More...
void	rollback ()
	Aborts the last changes made to the collection. Will always return true. More...
void	close ()
	no-op at the moment More...
void	open ()
	no-op at the moment More...
bool	isOpen () const
	Checks if the collection is open. More...
virtual const ICollectionDescription &	description () const
	Returns an object used to describe the collection properties. More...
virtual ICollectionSchemaEditor &	schemaEditor ()
	Returns an object used to modify the collection schema. More...
virtual ICollectionDataEditor &	dataEditor ()
	Returns an object used to add, update or delete rows of the collection. More...
virtual ICollectionQuery *	newQuery ()
	Returns an object used to query the collection. More...

Protected Member Functions
void	open (ICollection::OpenMode mode, ISession *session)

Private Attributes
IContainer *	m_container
	The underlying container handle. More...
CollectionDescription	m_description

Detailed Description

An implicit collection implementation of the ICollection interface.

Definition at line 26 of file ImplicitCollection.h.

Member Typedef Documentation

Factory

typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> pool::ImplicitCollection::Factory

Definition at line 30 of file ImplicitCollection.h.

Member Enumeration Documentation

OpenMode

enum pool::ICollection::OpenMode

inherited

Enumeration of the possible open modes of the collection.

Enumerator
CREATE
CREATE_AND_OVERWRITE
UPDATE
READ

Definition at line 27 of file ICollection.h.

{ CREATE, CREATE_AND_OVERWRITE, UPDATE, READ } OpenMode;

Constructor & Destructor Documentation

ImplicitCollection() [1/3]

pool::ImplicitCollection::ImplicitCollection	(	ISession *	session,
		const std::string &	connection,
		const std::string &	name,
		ICollection::OpenMode	mode
	)

Constructor - old style Throws POOL exception.

Parameters

session	the session object
connection	database connection string. It has the format databaseNameType:databaseName, where databaseNameType can be FID, PFN or LFN.
name	the container name in the database
mode	collection's open mode. For the moment only READONLY mode is allowed.

ImplicitCollection() [2/3]

pool::ImplicitCollection::ImplicitCollection	(	const ICollectionDescription *	description,
		ICollection::OpenMode	mode,
		ISession *	session
	)

Constructor compying to the new Collections API parameters as above, but name and connection passed in description.

~ImplicitCollection()

pool::ImplicitCollection::~ImplicitCollection

(

)

Destructor.

ImplicitCollection() [3/3]

pool::ImplicitCollection::ImplicitCollection ( const ImplicitCollection &  )

delete

Member Function Documentation

close()

void pool::ImplicitCollection::close ( )

virtual

no-op at the moment

Implements pool::ICollection.

commit()

void pool::ImplicitCollection::commit ( bool  reopen = false )

virtual

Commits the last changes made to the collection. Will always return true.

Implements pool::ICollection.

dataEditor()

virtual ICollectionDataEditor& pool::ImplicitCollection::dataEditor ( )

virtual

Returns an object used to add, update or delete rows of the collection.

will throw exception if called

Implements pool::ICollection.

description()

virtual const ICollectionDescription& pool::ImplicitCollection::description ( ) const

virtual

Returns an object used to describe the collection properties.

Implements pool::ICollection.

isOpen()

bool pool::ImplicitCollection::isOpen ( ) const

virtual

Checks if the collection is open.

Implements pool::ICollection.

newQuery()

virtual ICollectionQuery* pool::ImplicitCollection::newQuery ( )

virtual

Returns an object used to query the collection.

Implements pool::ICollection.

open() [1/2]

void pool::ImplicitCollection::open ( )

virtual

no-op at the moment

Implements pool::ICollection.

open() [2/2]

void pool::ImplicitCollection::open ( ICollection::OpenMode  mode, ISession *  session  )

protected

openMode()

virtual ICollection::OpenMode pool::ImplicitCollection::openMode ( ) const

virtual

Return openMode.

Implements pool::ICollection.

operator=()

ImplicitCollection& pool::ImplicitCollection::operator= ( const ImplicitCollection &  )

delete

rollback()

void pool::ImplicitCollection::rollback

(

)

Aborts the last changes made to the collection. Will always return true.

schemaEditor()

virtual ICollectionSchemaEditor& pool::ImplicitCollection::schemaEditor ( )

virtual

Returns an object used to modify the collection schema.

will throw exception if called

Implements pool::ICollection.

select()

ImplicitCollectionIterator* pool::ImplicitCollection::select	(	const std::string &	primaryQuery = "",
		std::string	secondaryQuery = "",
		std::string	options = ""
	)

Method that returns collection's iterator Throws POOL exception.

Parameters

primaryQuery	query string passed to the underlying StorageSvc implementation.
secondaryQuery	parameter currently unused
options	type currently unused

Member Data Documentation

m_container

IContainer* pool::ImplicitCollection::m_container

private

The underlying container handle.

Definition at line 107 of file ImplicitCollection.h.

m_description

CollectionDescription pool::ImplicitCollection::m_description

private

Definition at line 109 of file ImplicitCollection.h.

---

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

• ImplicitCollection.h