pool::ICollectionDescription Class Reference

An interface used to define the properties of a collection to be constructed and to retrieve these properties after construction. More...

#include <CollectionSvc/ICollectionDescription.h>

Inheritance diagram for pool::ICollectionDescription:

Collaboration diagram for pool::ICollectionDescription:

Public Member Functions
	ICollectionDescription ()=default
virtual const std::string &	name () const =0
	Returns the name of the collection.
virtual const std::string &	type () const =0
	Returns the storage technology type of the collection.
virtual const std::string &	connection () const =0
	Returns the connection to the database containing the collection.
virtual const std::string &	eventReferenceColumnName () const =0
	Returns the name reserved for the event reference Token column.
virtual int	numberOfTokenColumns () const =0
	Returns the number of Token columns (including the event reference column if it is used)
virtual const ICollectionColumn &	tokenColumn (int columnId) const =0
	Returns a description object for a Token column of the collection, given the position of the column.
virtual int	numberOfAttributeColumns () const =0
	Returns the number of Attribute columns.
virtual const ICollectionColumn &	attributeColumn (int columnId) const =0
	Returns a description object for an Attribute column of the collection, given the position of the column.

Protected Member Functions
virtual	~ICollectionDescription ()
	Empty destructor.

Detailed Description

An interface used to define the properties of a collection to be constructed and to retrieve these properties after construction.

The schema editor of the collection should be used for any modifications to these properties after construction.

Definition at line 22 of file ICollectionDescription.h.

Constructor & Destructor Documentation

ICollectionDescription()

pool::ICollectionDescription::ICollectionDescription ( )

default

~ICollectionDescription()

virtual pool::ICollectionDescription::~ICollectionDescription ( )

inlineprotectedvirtual

Empty destructor.

Definition at line 70 of file ICollectionDescription.h.

{}

Member Function Documentation

attributeColumn()

virtual const ICollectionColumn & pool::ICollectionDescription::attributeColumn ( int columnId ) const

pure virtual

Returns a description object for an Attribute column of the collection, given the position of the column.

Parameters

columnId

Position of column in associated collection fragment.

Implemented in pool::CollectionDescription.

connection()

virtual const std::string & pool::ICollectionDescription::connection ( ) const

pure virtual

Returns the connection to the database containing the collection.

Implemented in pool::CollectionDescription.

eventReferenceColumnName()

virtual const std::string & pool::ICollectionDescription::eventReferenceColumnName ( ) const

pure virtual

Returns the name reserved for the event reference Token column.

If the name has not been set by the user a default name is returned.

Implemented in pool::CollectionDescription.

name()

virtual const std::string & pool::ICollectionDescription::name ( ) const

pure virtual

Returns the name of the collection.

Implemented in pool::CollectionDescription.

numberOfAttributeColumns()

virtual int pool::ICollectionDescription::numberOfAttributeColumns ( ) const

pure virtual

Returns the number of Attribute columns.

Implemented in pool::CollectionDescription.

numberOfTokenColumns()

virtual int pool::ICollectionDescription::numberOfTokenColumns ( ) const

pure virtual

Returns the number of Token columns (including the event reference column if it is used)

Implemented in pool::CollectionDescription.

tokenColumn()

virtual const ICollectionColumn & pool::ICollectionDescription::tokenColumn ( int columnId ) const

pure virtual

Returns a description object for a Token column of the collection, given the position of the column.

Parameters

columnId

Position of column.

Implemented in pool::CollectionDescription.

type()

virtual const std::string & pool::ICollectionDescription::type ( ) const

pure virtual

Returns the storage technology type of the collection.

Implemented in pool::CollectionDescription.

---

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

• ICollectionDescription.h