TableMetadata Class Reference

Provides services to query and modify table attributes and collections. More...

#include <TableMetadata.hpp>

Inheritance diagram for TableMetadata:

Public Member Functions
virtual bool	cast (const Object &from)
virtual bool	isConnected () const
virtual bool	isDisconnected () const
virtual Type::Enum	getClassType () const
virtual Type::Enum	getObjectType () const
virtual const char *	getDescription () const
virtual void	setDescription (const char *description)
virtual const char *	getName () const
virtual void	setName (const char *name)
virtual bool	containsColumn (const char *name)
virtual bool	containsColumn (const IdentityInfo &name)
virtual bool	exists ()
virtual ColumnIterator	getColumns ()
virtual ColumnMetadata	addColumn (const char *name, const ColumnType::Enum columnType=ColumnType::Int64)
virtual ColumnMetadata	addColumn (const IdentityInfo &name, const ColumnType::Enum columnType=ColumnType::Int64)
virtual void	clearColumns ()
TableMetadata &	operator= (const TableMetadata &src)
	TableMetadata (const TableMetadata &src)
virtual	~TableMetadata ()
	TableMetadata ()
Public Member Functions inherited from Object
void *	get () const
Object &	operator= (const Object &src)
	Object (const Object &src)
virtual	~Object ()
	Object ()
Public Member Functions inherited from TableInfo
TableInfo &	operator= (const TableInfo &src)
	TableInfo (const TableInfo &src)
virtual	~TableInfo ()
	TableInfo ()
Public Member Functions inherited from TableMutator
TableMutator &	operator= (const TableMutator &src)
	TableMutator (const TableMutator &src)
virtual	~TableMutator ()
	TableMutator ()

Additional Inherited Members
Protected Member Functions inherited from Object
	Object (void *src)
Protected Attributes inherited from Object
void *	m

Detailed Description

Provides services to query and modify table attributes and collections.

Definition at line 17 of file TableMetadata.hpp.

Constructor & Destructor Documentation

TableMetadata ( const TableMetadata &  src )

inline

Definition at line 111 of file TableMetadata.hpp.

virtual ~TableMetadata ( )

inlinevirtual

Definition at line 115 of file TableMetadata.hpp.

TableMetadata ( )

inline

Definition at line 116 of file TableMetadata.hpp.

Member Function Documentation

virtual ColumnMetadata addColumn ( const char *  name, const ColumnType::Enum  columnType = ColumnType::Int64  )

inlinevirtual

Adds a column to the table column collection.

Reimplemented from TableMutator.

Reimplemented in CreateTable.

Definition at line 98 of file TableMetadata.hpp.

virtual ColumnMetadata addColumn ( const IdentityInfo &  name, const ColumnType::Enum  columnType = ColumnType::Int64  )

inlinevirtual

Adds a column to the table column collection.

Reimplemented from TableMutator.

Reimplemented in CreateTable.

Definition at line 102 of file TableMetadata.hpp.

virtual bool cast ( const Object &  from )

inlinevirtual

Performs safe typecast.

Reimplemented from Object.

Reimplemented in CreateTable.

Definition at line 28 of file TableMetadata.hpp.

virtual void clearColumns ( )

inlinevirtual

Clears the table column collection.

Reimplemented from TableMutator.

Reimplemented in CreateTable.

Definition at line 106 of file TableMetadata.hpp.

virtual bool containsColumn ( const char *  name )

inlinevirtual

Determines wether the database table contains a column with the specified name.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 79 of file TableMetadata.hpp.

virtual bool containsColumn ( const IdentityInfo &  name )

inlinevirtual

Determines wether the database table contains a column with the specified name.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 83 of file TableMetadata.hpp.

virtual bool exists ( )

inlinevirtual

Determines wether the table exists in the database.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 87 of file TableMetadata.hpp.

virtual Type::Enum getClassType ( ) const

inlinevirtual

class type of the object.

Reimplemented from Object.

Reimplemented in CreateTable.

Definition at line 40 of file TableMetadata.hpp.

virtual ColumnIterator getColumns ( )

inlinevirtual

Gets Column iterator used to iterate columns information in the database table.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 91 of file TableMetadata.hpp.

virtual const char* getDescription ( ) const

inlinevirtual

Returns the description of the entity.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 51 of file TableMetadata.hpp.

virtual const char* getName ( ) const

inlinevirtual

Returns the name of the entity.

Reimplemented from TableInfo.

Reimplemented in CreateTable.

Definition at line 65 of file TableMetadata.hpp.

virtual Type::Enum getObjectType ( ) const

inlinevirtual

object type of the underlying derived object.

Reimplemented from Object.

Reimplemented in CreateTable.

Definition at line 44 of file TableMetadata.hpp.

virtual bool isConnected ( ) const

inlinevirtual

if underlying database is connected.

Reimplemented from Object.

Reimplemented in CreateTable.

Definition at line 32 of file TableMetadata.hpp.

virtual bool isDisconnected ( ) const

inlinevirtual

if underlying database is not connected.

Reimplemented from Object.

Reimplemented in CreateTable.

Definition at line 36 of file TableMetadata.hpp.

TableMetadata& operator= ( const TableMetadata &  src )

inline

Definition at line 110 of file TableMetadata.hpp.

virtual void setDescription ( const char *  description )

inlinevirtual

Sets the description of the entity.

Reimplemented from TableMutator.

Reimplemented in CreateTable.

Definition at line 58 of file TableMetadata.hpp.

virtual void setName ( const char *  name )

inlinevirtual

Sets the name of the entity.

Reimplemented from TableMutator.

Reimplemented in CreateTable.

Definition at line 72 of file TableMetadata.hpp.

---

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

• TableMetadata.hpp