#include <CollectionBase/ICollectionDescription.h>

Inheritance diagram for pool::ICollectionDescription:

Collaboration diagram for pool::ICollectionDescription:

Public Member Functions
virtual const std::string &	name () const =0
	Returns the name of the collection. More...

virtual const std::string &	type () const =0
	Returns the storage technology type of the collection. More...

virtual const std::string &	connection () const =0
	Returns the connection to the database containing the collection. More...

virtual const std::string &	eventReferenceColumnName () const =0
	Returns the name reserved for the event reference Token column. More...

virtual bool	hasEventReferenceColumn () const =0
	Indicates whether the collection contains the event reference column. More...

virtual int	numberOfColumns () const =0
	Returns the number of columns (including the event reference column if it is used) in the collection. More...

virtual const ICollectionColumn &	column (const std::string &columnName) const =0
	Returns a description object for a column of the collection, given the name of the column. More...

virtual const ICollectionColumn *	columnPtr (const std::string &columnName) const =0
	return pointer to Column or NULL if it's not found (will not throw exceptions) More...

virtual int	numberOfTokenColumns () const =0
	Returns the number of Token columns (including the event reference column if it is used) More...

virtual const ICollectionColumn &	tokenColumn (const std::string &columnName) const =0
	Returns a description object for a Token column of the collection, given the name of the column. More...

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. More...

virtual int	numberOfAttributeColumns () const =0
	Returns the number of Attribute columns. More...

virtual const ICollectionColumn &	attributeColumn (const std::string &columnName) const =0
	Returns a description object for an Attribute column of the collection, given the name of the column. More...

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. More...

virtual int	numberOfIndices () const =0
	Returns the number of indices used by the collection. More...

virtual const ICollectionIndex &	index (const std::string &columnName) const =0
	Returns a description object for an index of the collection, given the name of the column on which the index is applied. More...

virtual const ICollectionIndex &	index (const std::vector< std::string > &columnNames) const =0
	Returns a description object for an index of the collection, given the names of the columns on which the index is applied. More...

virtual const ICollectionIndex &	index (int indexId) const =0
	Returns a description object for an index of the collection, given the ID number of the index. More...

virtual bool	equals (const ICollectionDescription &rhs) const =0
	Check if both Descriptions have the same columns. More...

virtual bool	isSubsetOf (const ICollectionDescription &rhs) const =0
	Check if all columns from this Description are present in the rhs Description and if they have the same type. More...

virtual void	printOut () const
	print out the description (optional debugging) More...

Protected Member Functions
virtual	~ICollectionDescription ()
	Empty destructor. More...

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 25 of file ICollectionDescription.h.

Constructor & Destructor Documentation

◆ ~ICollectionDescription()

virtual pool::ICollectionDescription::~ICollectionDescription ( )

inlineprotectedvirtual

Empty destructor.

Definition at line 156 of file ICollectionDescription.h.

156 {}

Member Function Documentation

◆ attributeColumn() [1/2]

virtual const ICollectionColumn& pool::ICollectionDescription::attributeColumn ( const std::string & columnName ) const

pure virtual

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

Parameters

columnName Name of column.

Implemented in pool::CollectionDescription.

◆ attributeColumn() [2/2]

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.

◆ column()

virtual const ICollectionColumn& pool::ICollectionDescription::column ( const std::string & columnName ) const

pure virtual

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

Parameters

columnName Name of column.

Implemented in pool::CollectionDescription.

◆ columnPtr()

virtual const ICollectionColumn* pool::ICollectionDescription::columnPtr ( const std::string & columnName ) const

pure virtual

return pointer to Column or NULL if it's not found (will not throw exceptions)

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.

◆ equals()

virtual bool pool::ICollectionDescription::equals ( const ICollectionDescription & rhs ) const

pure virtual

Check if both Descriptions have the same columns.

Parameters

rhs	Collection description object to compare.

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.

◆ hasEventReferenceColumn()

virtual bool pool::ICollectionDescription::hasEventReferenceColumn ( ) const

pure virtual

Indicates whether the collection contains the event reference column.

Implemented in pool::CollectionDescription.

◆ index() [1/3]

virtual const ICollectionIndex& pool::ICollectionDescription::index ( const std::string & columnName ) const

pure virtual

Returns a description object for an index of the collection, given the name of the column on which the index is applied.

Parameters

columnName Name of column on which index is applied.

Implemented in pool::CollectionDescription.

◆ index() [2/3]

virtual const ICollectionIndex& pool::ICollectionDescription::index ( const std::vector< std::string > & columnNames ) const

pure virtual

Returns a description object for an index of the collection, given the names of the columns on which the index is applied.

Parameters

columnNames Names of columns on which index is applied.

Implemented in pool::CollectionDescription.

◆ index() [3/3]

virtual const ICollectionIndex& pool::ICollectionDescription::index ( int indexId ) const

pure virtual

Returns a description object for an index of the collection, given the ID number of the index.

Parameters

indexId ID of index.

Implemented in pool::CollectionDescription.

◆ isSubsetOf()

virtual bool pool::ICollectionDescription::isSubsetOf ( const ICollectionDescription & rhs ) const

pure virtual

Check if all columns from this Description are present in the rhs Description and if they have the same type.

Parameters

rhs	Collection description object to compare.

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.

◆ numberOfColumns()

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

pure virtual

Returns the number of columns (including the event reference column if it is used) in the collection.

Implemented in pool::CollectionDescription.

◆ numberOfIndices()

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

pure virtual

Returns the number of indices used by the collection.

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.

◆ printOut()

virtual void pool::ICollectionDescription::printOut ( ) const

inlinevirtual

print out the description (optional debugging)

Reimplemented in pool::CollectionDescription.

Definition at line 152 of file ICollectionDescription.h.

152 {}

◆ tokenColumn() [1/2]

virtual const ICollectionColumn& pool::ICollectionDescription::tokenColumn ( const std::string & columnName ) const

pure virtual

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

Parameters

columnName Name of column.

Implemented in pool::CollectionDescription.

◆ tokenColumn() [2/2]

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ICollectionDescription()

Member Function Documentation

◆ attributeColumn() [1/2]

◆ attributeColumn() [2/2]

◆ column()

◆ columnPtr()

◆ connection()

◆ equals()

◆ eventReferenceColumnName()

◆ hasEventReferenceColumn()

◆ index() [1/3]

◆ index() [2/3]

◆ index() [3/3]

◆ isSubsetOf()

◆ name()

◆ numberOfAttributeColumns()

◆ numberOfColumns()

◆ numberOfIndices()

◆ numberOfTokenColumns()

◆ printOut()

◆ tokenColumn() [1/2]

◆ tokenColumn() [2/2]

◆ type()