pool::CollectionService Class Reference

#include <CollectionBase/CollectionService.h>

Collaboration diagram for pool::CollectionService:

Public Member Functions
	CollectionService ()=default
	Constructor: More...
virtual	~CollectionService ()=default
	Default destructor. More...
virtual ICollection *	create (const ICollectionDescription &description, bool overwrite=false)
	Creates or overwrites a collection or collection fragment, given a description of its properties. More...
virtual ICollection *	open (const std::string &name, const std::string &type, const std::string &connection="", bool readOnly=true) const
virtual ICollection *	handle (const std::string &name, const std::string &type, const std::string &connection="", bool readOnly=true, ISession *session=0) const
	Retrieves a handle to an existing collection or collection fragment for read or update transactions, given the collection or collection fragment's name, storage technology type and database connection string. More...
pool::ICollection *	plugin (const ICollectionDescription &description, ICollection::OpenMode openMode, ISession *session=0) const

Static Public Member Functions
static void	setMessageSvcQuiet (bool quiet=true)
	suppress (or enable) warning about a missing MessageSvc (logging) More...

Detailed Description

A service for creating, accessing and managing an ensemble of collections of event references. In many cases, the individual unit managed by the service may simply consist of a collection fragment containing only a subset of the metadata of an existing collection.

Definition at line 25 of file CollectionService.h.

Constructor & Destructor Documentation

CollectionService()

pool::CollectionService::CollectionService ( )

default

Constructor:

Parameters

context

Local context provided by the service.

~CollectionService()

virtual pool::CollectionService::~CollectionService ( )

virtualdefault

Default destructor.

Member Function Documentation

create()

virtual ICollection* pool::CollectionService::create ( const ICollectionDescription &  description, bool  overwrite = false  )

virtual

Creates or overwrites a collection or collection fragment, given a description of its properties.

Parameters

description	Specification of collection or collection fragment properties.
overwrite	Flag to distinguish creation and overwrite open modes.

handle()

virtual ICollection* pool::CollectionService::handle ( const std::string &  name, const std::string &  type, const std::string &  connection = "", bool  readOnly = true, ISession *  session = 0  ) const

virtual

Retrieves a handle to an existing collection or collection fragment for read or update transactions, given the collection or collection fragment's name, storage technology type and database connection string.

A reference to a POOL database session object must be provided as input for the case where the collection being accessed is of type "ImplicitCollection".

Parameters

name	Name of collection or collection fragment.
type	Storage technology type of collection or collection fragment.
connection	Connection to database containing collection or collection fragment.
readOnly	Flag to distinguish read and update open modes.
session	Reference to database session (need only be set for implicit collections).

open()

virtual ICollection* pool::CollectionService::open ( const std::string &  name, const std::string &  type, const std::string &  connection = "", bool  readOnly = true  ) const

inlinevirtual

Definition at line 50 of file CollectionService.h.

    {
       return handle(name, type, connection, readOnly, 0);
    }

plugin()

pool::ICollection* pool::CollectionService::plugin	(	const ICollectionDescription &	description,
		ICollection::OpenMode	openMode,
		ISession *	session = 0
	)		const

setMessageSvcQuiet()

static void pool::CollectionService::setMessageSvcQuiet ( bool  quiet = true )

static

suppress (or enable) warning about a missing MessageSvc (logging)

---

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

• CollectionService.h