pool::ICollection Class Reference

An interface to a storage technology specific collection of event references and attributes. More...

#include <Collection/ICollection.h>

Inheritance diagram for pool::ICollection:

Collaboration diagram for pool::ICollection:

Public Types
enum	OpenMode { CREATE , CREATE_AND_OVERWRITE , UPDATE , READ }
	Enumeration of the possible open modes of the collection. More...

Public Member Functions
virtual ICollection::OpenMode	openMode () const =0
	Returns the open mode of the collection for the present transaction.
virtual void	open ()=0
	Opens the collection and initializes it if necessary.
virtual bool	isOpen () const =0
	Checks if the collection is open.
virtual void	initNewRow (pool::CollectionRowBuffer &row) const
	Initialize a new RowBuffer by adding all Attributes adn Tokens of this collection to it.
virtual void	insertRow (const pool::CollectionRowBuffer &inputRowBuffer)=0
	Adds a new row of data to the collection.
virtual void	commit (bool restartTransaction=true)=0
	Commits the latest changes made to the collection.
virtual void	close ()=0
	Closes the collection and terminates any database connections.
virtual const ICollectionDescription &	description () const =0
	Returns an object used to describe the collection properties.
virtual ICollectionCursor &	cursor ()=0
	Returns an cursor for the collection.
virtual	~ICollection ()=default
	Empty destructor.

Detailed Description

An interface to a storage technology specific collection of event references and attributes.

Definition at line 22 of file ICollection.h.

Member Enumeration Documentation

OpenMode

enum pool::ICollection::OpenMode

Enumeration of the possible open modes of the collection.

Enumerator
CREATE
CREATE_AND_OVERWRITE
UPDATE
READ

Definition at line 26 of file ICollection.h.

{ CREATE, CREATE_AND_OVERWRITE, UPDATE, READ } OpenMode;

Constructor & Destructor Documentation

~ICollection()

virtual pool::ICollection::~ICollection ( )

virtualdefault

Empty destructor.

Member Function Documentation

close()

virtual void pool::ICollection::close ( )

pure virtual

Closes the collection and terminates any database connections.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

commit()

virtual void pool::ICollection::commit ( bool restartTransaction = true )

pure virtual

Commits the latest changes made to the collection.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

cursor()

virtual ICollectionCursor & pool::ICollection::cursor ( )

pure virtual

Returns an cursor for the collection.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

description()

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

pure virtual

Returns an object used to describe the collection properties.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

initNewRow()

virtual void pool::ICollection::initNewRow ( pool::CollectionRowBuffer & row ) const

virtual

Initialize a new RowBuffer by adding all Attributes adn Tokens of this collection to it.

insertRow()

virtual void pool::ICollection::insertRow ( const pool::CollectionRowBuffer & inputRowBuffer )

pure virtual

Adds a new row of data to the collection.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

isOpen()

virtual bool pool::ICollection::isOpen ( ) const

pure virtual

Checks if the collection is open.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

open()

virtual void pool::ICollection::open ( )

pure virtual

Opens the collection and initializes it if necessary.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

openMode()

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

pure virtual

Returns the open mode of the collection for the present transaction.

Implemented in pool::ImplicitCollection, pool::RootCollection::RNTCollection, and pool::RootCollection::RootCollection.

---

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

• ICollection.h