Class Hierarchy   Class Index   Method Index  

CHMtableDefClass.h

00001 #ifndef __CHM_TABLE_DEFINITION_CLASS_H__
00002 #define __CHM_TABLE_DEFINITION_CLASS_H__
00003 
00004 #include <CHM/CHMminimumInclude.h>
00005 #include <CHM/CHMdataType.h>
00006 class CHMtableDefinitionPrivate;
00007 
00008 class CHMtableDefinition
00009 {
00010 public:
00011    CHMtableDefinition();
00012    explicit CHMtableDefinition(CHMtableDefinitionHandle Handle);
00013    virtual ~CHMtableDefinition();
00014 
00015    
00016    const char* TableName() const;
00017 
00018    CHMtableDefinitionHandle GetTableDefHandle() const;
00019 
00020   
00021    // These methods are used for accessing the columns
00022    // at runtime - ColumnIndex will return size_t(-1) for
00023    // a non-existent column name
00024    size_t CountOfColumn() const;
00025    const char* ColumnName(size_t ColumnIndex) const;
00026    CHMdataType ColumnType(size_t ColumnIndex) const;
00027 
00028    CHMboolean IsKey(size_t ColumnIndex) const;
00029 
00030    // This function is deprecated. Use Dump instead. See manual for migration guide.
00031    //
00032    // void printOn(IOostream& Stream) const;
00033 
00037    CHMstring Dump() const;
00038 
00039 private:
00040    CHMtableDefinitionPrivate* pMember;
00041    CHMtableDefinition(const CHMtableDefinition& Orig);             // not allowed
00042    CHMtableDefinition& operator=(const CHMtableDefinition& Orig);  // not allowed
00043 };
00044 
00045 // This function is deprecated. Use Dump instead. See manual for migration guide.
00046 //
00047 // IOostream& operator<<(IOostream& Stream, const CHMtableDefinition& TableDef);
00048 
00049 #endif // __CHM_TABLE_DEFINITION_CLASS_H__