pool::ICollectionSchemaEditor Class Reference

#include <CollectionBase/ICollectionSchemaEditor.h>

Inheritance diagram for pool::ICollectionSchemaEditor:

Collaboration diagram for pool::ICollectionSchemaEditor:

Public Member Functions
virtual void	setEventReferenceColumnName (const std::string &columnName)=0
	Sets the name of the event reference Token column. More...
virtual const ICollectionColumn &	insertColumn (const std::string &columnName, const std::string &columnType, const std::string &annotation="", int maxSize=0, bool sizeIsFixed=true)=0
	Adds a new column to the collection. More...
virtual const ICollectionColumn &	insertColumn (const std::string &columnName, const std::type_info &columnType, const std::string &annotation="", int maxSize=0, bool sizeIsFixed=true)=0
	Adds a new column to the collection. More...
virtual const ICollectionColumn &	insertTokenColumn (const std::string &columnName, const std::string &annotation="")=0
	Adds a new column of type pool::Token to the collection. More...
virtual const ICollectionColumn &	annotateColumn (const std::string &columnName, const std::string &annotation)=0
	add annotation to column More...
virtual void	dropColumn (const std::string &columnName)=0
	Removes a column from the collection. More...
virtual void	renameColumn (const std::string &oldName, const std::string &newName)=0
	Renames a column of the collection. More...
virtual	~ICollectionSchemaEditor ()
	Empty destructor. More...

Detailed Description

An interface used to define the schema of a collection.

Definition at line 21 of file ICollectionSchemaEditor.h.

Constructor & Destructor Documentation

~ICollectionSchemaEditor()

virtual pool::ICollectionSchemaEditor::~ICollectionSchemaEditor ( )

inlinevirtual

Empty destructor.

Definition at line 94 of file ICollectionSchemaEditor.h.

{}

Member Function Documentation

annotateColumn()

virtual const ICollectionColumn& pool::ICollectionSchemaEditor::annotateColumn ( const std::string &  columnName, const std::string &  annotation  )

pure virtual

add annotation to column

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

dropColumn()

virtual void pool::ICollectionSchemaEditor::dropColumn ( const std::string &  columnName )

pure virtual

Removes a column from the collection.

Parameters

columnName

Name of column to be removed.

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

insertColumn() [1/2]

virtual const ICollectionColumn& pool::ICollectionSchemaEditor::insertColumn ( const std::string &  columnName, const std::string &  columnType, const std::string &  annotation = "", int  maxSize = 0, bool  sizeIsFixed = true  )

pure virtual

Adds a new column to the collection.

Parameters

columnName	Name of new column.
columnType	Data type of new column.
maxSize	Maximum size of column data type (useful for string or blob data types).
sizeIsFixed	Flag indicating whether size of column data type is fixed (useful for string or blob data types).

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

insertColumn() [2/2]

virtual const ICollectionColumn& pool::ICollectionSchemaEditor::insertColumn ( const std::string &  columnName, const std::type_info &  columnType, const std::string &  annotation = "", int  maxSize = 0, bool  sizeIsFixed = true  )

pure virtual

Adds a new column to the collection.

Parameters

columnName	Name of new column.
columnType	Data type of new column.
maxSize	Maximum size of column data type (useful for string or blob data types).
sizeIsFixed	Flag indicating whether size of column data type is fixed (useful for string or blob data types).

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

insertTokenColumn()

virtual const ICollectionColumn& pool::ICollectionSchemaEditor::insertTokenColumn ( const std::string &  columnName, const std::string &  annotation = ""  )

pure virtual

Adds a new column of type pool::Token to the collection.

Parameters

columnName

Name of new column.

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

renameColumn()

virtual void pool::ICollectionSchemaEditor::renameColumn ( const std::string &  oldName, const std::string &  newName  )

pure virtual

Renames a column of the collection.

Parameters

oldName	Old name of column.
newName	New name of column.

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

setEventReferenceColumnName()

virtual void pool::ICollectionSchemaEditor::setEventReferenceColumnName ( const std::string &  columnName )

pure virtual

Sets the name of the event reference Token column.

Otherwise a default name is used.

Parameters

columnName

Name of event reference Token column.

Implemented in pool::CollectionDescription, pool::RootCollection::RNTCollectionSchemaEditor, and pool::RootCollection::RootCollectionSchemaEditor.

---

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

• ICollectionSchemaEditor.h