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

Provides services to query and modify Column attributes. More...

#include <ColumnMetadata.hpp>

+ Inheritance diagram for ColumnMetadata:

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 bool exists ()
virtual ColumnState::Enum getState () const
virtual ColumnType::Enum getType () const
virtual uint32_t getLength () const
virtual void setLength (const uint32_t length)
virtual void setType (const ColumnType::Enum columnType)
virtual const char * getDescription () const
virtual void setDescription (const char *description)
virtual const char * getName () const
virtual void setName (const char *name)
ColumnMetadataoperator= (const ColumnMetadata &src)
 ColumnMetadata (const ColumnMetadata &src)
virtual ~ColumnMetadata ()
 ColumnMetadata ()
- 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 ColumnInfo
ColumnInfooperator= (const ColumnInfo &src)
 ColumnInfo (const ColumnInfo &src)
virtual ~ColumnInfo ()
 ColumnInfo ()
- Public Member Functions inherited from ColumnMutator
ColumnMutatoroperator= (const ColumnMutator &src)
 ColumnMutator (const ColumnMutator &src)
virtual ~ColumnMutator ()
 ColumnMutator ()

Friends

class AlterTable
class CreateTable
class TableMetadata
class 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 Column attributes.

Definition at line 17 of file ColumnMetadata.hpp.

Constructor & Destructor Documentation

ColumnMetadata ( const ColumnMetadata src)
inline

Definition at line 94 of file ColumnMetadata.hpp.

virtual ~ColumnMetadata ( )
inlinevirtual

Definition at line 98 of file ColumnMetadata.hpp.

ColumnMetadata ( )
inline

Definition at line 99 of file ColumnMetadata.hpp.

Member Function Documentation

virtual bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from ColumnInfo.

Definition at line 33 of file ColumnMetadata.hpp.

virtual bool exists ( )
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 53 of file ColumnMetadata.hpp.

virtual Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from ColumnInfo.

Definition at line 45 of file ColumnMetadata.hpp.

virtual const char* getDescription ( ) const
inlinevirtual

Returns the description of the entity.

Reimplemented from ColumnInfo.

Definition at line 68 of file ColumnMetadata.hpp.

virtual uint32_t getLength ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 56 of file ColumnMetadata.hpp.

virtual const char* getName ( ) const
inlinevirtual

Returns the name of the entity.

Reimplemented from ColumnInfo.

Definition at line 82 of file ColumnMetadata.hpp.

virtual Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from ColumnInfo.

Definition at line 49 of file ColumnMetadata.hpp.

virtual ColumnState::Enum getState ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 54 of file ColumnMetadata.hpp.

virtual ColumnType::Enum getType ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 55 of file ColumnMetadata.hpp.

virtual bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from ColumnInfo.

Definition at line 37 of file ColumnMetadata.hpp.

virtual bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from ColumnInfo.

Definition at line 41 of file ColumnMetadata.hpp.

ColumnMetadata& operator= ( const ColumnMetadata src)
inline

Definition at line 93 of file ColumnMetadata.hpp.

virtual void setDescription ( const char *  description)
inlinevirtual

Sets the description of the entity.

Reimplemented from ColumnMutator.

Definition at line 75 of file ColumnMetadata.hpp.

virtual void setLength ( const uint32_t  length)
inlinevirtual

Reimplemented from ColumnMutator.

Definition at line 60 of file ColumnMetadata.hpp.

virtual void setName ( const char *  name)
inlinevirtual

Sets the name of the entity.

Reimplemented from ColumnMutator.

Definition at line 89 of file ColumnMetadata.hpp.

virtual void setType ( const ColumnType::Enum  columnType)
inlinevirtual

Reimplemented from ColumnMutator.

Definition at line 61 of file ColumnMetadata.hpp.

Friends And Related Function Documentation

friend class AlterTable
friend

Definition at line 23 of file ColumnMetadata.hpp.

friend class CreateTable
friend

Definition at line 24 of file ColumnMetadata.hpp.

friend class TableMetadata
friend

Definition at line 25 of file ColumnMetadata.hpp.

friend class TableMutator
friend

Definition at line 26 of file ColumnMetadata.hpp.


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