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

Table class represents a physical table in a database. More...

#include <Table.hpp>

+ Inheritance diagram for Table:

Public Member Functions

bool cast (const Object &from)
bool isConnected () const
bool isDisconnected () const
Type::Enum getClassType () const
Type::Enum getObjectType () const
Error::Enum getLastErrorId () const
const char * getLastError () const
const char * getDescription () const
const char * getName () const
Record getRecord ()
bool containsColumn (const char *name)
bool containsColumn (const IdentityInfo &name)
bool exists ()
ColumnIterator getColumns ()
Tableoperator= (const Table &src)
 Table (const Table &src)
virtual ~Table ()
 Table ()
- 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 LastError
LastErroroperator= (const LastError &src)
 LastError (const LastError &src)
virtual ~LastError ()
 LastError ()
- Public Member Functions inherited from TableDml
TableDmloperator= (const TableDml &src)
 TableDml (const TableDml &src)
virtual ~TableDml ()
 TableDml ()
- Public Member Functions inherited from TableInfo
TableInfooperator= (const TableInfo &src)
 TableInfo (const TableInfo &src)
virtual ~TableInfo ()
 TableInfo ()

Friends

class Database

Additional Inherited Members

- Protected Member Functions inherited from Object
 Object (void *src)
- Protected Attributes inherited from Object
void * m

Detailed Description

Table class represents a physical table in a database.

Definition at line 18 of file Table.hpp.

Constructor & Destructor Documentation

Table ( const Table src)
inline

Definition at line 104 of file Table.hpp.

virtual ~Table ( )
inlinevirtual

Definition at line 108 of file Table.hpp.

Table ( )
inline

Definition at line 109 of file Table.hpp.

Member Function Documentation

bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from LastError.

Definition at line 32 of file Table.hpp.

bool containsColumn ( const char *  name)
inlinevirtual

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

Reimplemented from TableInfo.

Definition at line 87 of file Table.hpp.

bool containsColumn ( const IdentityInfo name)
inlinevirtual

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

Reimplemented from TableInfo.

Definition at line 91 of file Table.hpp.

bool exists ( )
inlinevirtual

Determines wether the table exists in the database.

Reimplemented from TableInfo.

Definition at line 95 of file Table.hpp.

Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from LastError.

Definition at line 44 of file Table.hpp.

ColumnIterator getColumns ( )
inlinevirtual

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

Reimplemented from TableInfo.

Definition at line 99 of file Table.hpp.

const char* getDescription ( ) const
inlinevirtual

Returns the description of the entity.

Reimplemented from TableInfo.

Definition at line 66 of file Table.hpp.

const char* getLastError ( ) const
inlinevirtual

Retrieves the calling object last-error text message.

Reimplemented from LastError.

Definition at line 59 of file Table.hpp.

Error::Enum getLastErrorId ( ) const
inlinevirtual

Retrieves the calling object last-error id value.

Reimplemented from LastError.

Definition at line 55 of file Table.hpp.

const char* getName ( ) const
inlinevirtual

Returns the name of the entity.

Reimplemented from TableInfo.

Definition at line 73 of file Table.hpp.

Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from LastError.

Definition at line 48 of file Table.hpp.

Record getRecord ( )
inlinevirtual

Gets Record Statement.

Reimplemented from TableDml.

Definition at line 80 of file Table.hpp.

bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from LastError.

Definition at line 36 of file Table.hpp.

bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from LastError.

Definition at line 40 of file Table.hpp.

Table& operator= ( const Table src)
inline

Definition at line 103 of file Table.hpp.

Friends And Related Function Documentation

friend class Database
friend

Definition at line 25 of file Table.hpp.


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