pool::ICollectionColumn Class Reference

#include <CollectionBase/ICollectionColumn.h>

Inheritance diagram for pool::ICollectionColumn:

Collaboration diagram for pool::ICollectionColumn:

Public Member Functions
virtual const std::string &	name () const =0
	Returns the name of the column. More...
virtual const std::string &	type () const =0
	Returns the data type of the column. More...
virtual const std::string &	annotation () const =0
	Returns the user annotation for this column. More...
virtual int	maxSize () const =0
	Returns the maximum size of the column data type. More...
virtual bool	sizeIsFixed () const =0
	Indicates whether the data type of the column can vary in size. More...
virtual int	id () const =0
	Returns the position of the column in its associated collection fragment. More...

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

Detailed Description

An interface for retrieving a description of a column of a collection.

Definition at line 18 of file ICollectionColumn.h.

Constructor & Destructor Documentation

~ICollectionColumn()

virtual pool::ICollectionColumn::~ICollectionColumn ( )

inlineprotectedvirtual

Empty destructor.

Definition at line 47 of file ICollectionColumn.h.

{}

Member Function Documentation

annotation()

virtual const std::string& pool::ICollectionColumn::annotation ( ) const

pure virtual

Returns the user annotation for this column.

Implemented in pool::CollectionColumn.

id()

virtual int pool::ICollectionColumn::id ( ) const

pure virtual

Returns the position of the column in its associated collection fragment.

Implemented in pool::CollectionColumn.

maxSize()

virtual int pool::ICollectionColumn::maxSize ( ) const

pure virtual

Returns the maximum size of the column data type.

This information is useful for data of type string or blob.

Implemented in pool::CollectionColumn.

name()

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

pure virtual

Returns the name of the column.

Implemented in pool::CollectionColumn.

sizeIsFixed()

virtual bool pool::ICollectionColumn::sizeIsFixed ( ) const

pure virtual

Indicates whether the data type of the column can vary in size.

This information is useful for data of type string or blob.

Implemented in pool::CollectionColumn.

type()

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

pure virtual

Returns the data type of the column.

Implemented in pool::CollectionColumn.

---

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

• ICollectionColumn.h