pool::ICollectionIndex Class Reference

#include <CollectionBase/ICollectionIndex.h>

Inheritance diagram for pool::ICollectionIndex:

Collaboration diagram for pool::ICollectionIndex:

Public Member Functions
virtual const std::string &	name () const =0
	Returns the name of the index. More...
virtual const std::vector< std::string > &	columnNames () const =0
	Returns the names of all columns on which the index is created. More...
virtual bool	isUnique () const =0
	Indicates whether the combination of indexed column values must be different for each row. More...

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

Detailed Description

An interface for retrieving a description of an index on one or more columns of a collection.

Definition at line 19 of file ICollectionIndex.h.

Constructor & Destructor Documentation

~ICollectionIndex()

virtual pool::ICollectionIndex::~ICollectionIndex ( )

inlineprotectedvirtual

Empty destructor.

Definition at line 33 of file ICollectionIndex.h.

{}

Member Function Documentation

columnNames()

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

pure virtual

Returns the names of all columns on which the index is created.

Implemented in pool::CollectionIndex.

isUnique()

virtual bool pool::ICollectionIndex::isUnique ( ) const

pure virtual

Indicates whether the combination of indexed column values must be different for each row.

Implemented in pool::CollectionIndex.

name()

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

pure virtual

Returns the name of the index.

Implemented in pool::CollectionIndex.

---

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

• ICollectionIndex.h