CompleteDB Embedded: Direct C++ API  2.4.2
TableInfo Class Reference

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

#include <TableInfo.hpp>

+ Inheritance diagram for TableInfo:

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 const char * getName () const
virtual bool containsColumn (const char *name)
virtual bool containsColumn (const IdentityInfo &name)
virtual bool exists ()
virtual ColumnIterator getColumns ()
TableInfooperator= (const TableInfo &src)
 TableInfo (const TableInfo &src)
virtual ~TableInfo ()
 TableInfo ()
- Public Member Functions inherited from Object
void * get () const
Objectoperator= (const Object &src)
 Object (const Object &src)
virtual ~Object ()
 Object ()
- Public Member Functions inherited from EntityInfo
EntityInfooperator= (const EntityInfo &src)
 EntityInfo (const EntityInfo &src)
virtual ~EntityInfo ()
 EntityInfo ()

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 table attributes and collections.

Definition at line 18 of file TableInfo.hpp.

Constructor & Destructor Documentation

TableInfo ( const TableInfo src)
inline

Definition at line 82 of file TableInfo.hpp.

virtual ~TableInfo ( )
inlinevirtual

Definition at line 86 of file TableInfo.hpp.

TableInfo ( )
inline

Definition at line 87 of file TableInfo.hpp.

Member Function Documentation

virtual bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 28 of file TableInfo.hpp.

virtual bool containsColumn ( const char *  name)
inlinevirtual

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

Reimplemented in CreateTable, Table, TableIterator, and TableMetadata.

Definition at line 65 of file TableInfo.hpp.

virtual bool containsColumn ( const IdentityInfo name)
inlinevirtual

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

Reimplemented in CreateTable, Table, TableIterator, and TableMetadata.

Definition at line 69 of file TableInfo.hpp.

virtual bool exists ( )
inlinevirtual

Determines wether the table exists in the database.

Reimplemented in CreateTable, Table, TableIterator, and TableMetadata.

Definition at line 73 of file TableInfo.hpp.

virtual Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 40 of file TableInfo.hpp.

virtual ColumnIterator getColumns ( )
inlinevirtual

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

Reimplemented in CreateTable, Table, TableIterator, and TableMetadata.

Definition at line 77 of file TableInfo.hpp.

virtual const char* getDescription ( ) const
inlinevirtual

Returns the description of the entity.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 51 of file TableInfo.hpp.

virtual const char* getName ( ) const
inlinevirtual

Returns the name of the entity.

Reimplemented from EntityInfo.

Reimplemented in CreateTable, Table, TableIterator, and TableMetadata.

Definition at line 58 of file TableInfo.hpp.

virtual Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 44 of file TableInfo.hpp.

virtual bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 32 of file TableInfo.hpp.

virtual bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from EntityInfo.

Reimplemented in Table, CreateTable, TableIterator, and TableMetadata.

Definition at line 36 of file TableInfo.hpp.

TableInfo& operator= ( const TableInfo src)
inline

Definition at line 81 of file TableInfo.hpp.


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