TTCatalogTableリファレンス

最上位レベルのTTCatalogクラスの各オブジェクト内には、TTCatalogTableオブジェクトの配列が含まれます。

パブリック・メンバー

なし

パブリック・メソッド

この項では、TTCatalogTableパブリック・メソッドの概要を説明します。

パブリック・メソッドの概要

メソッド	説明
`getColumn()`	表の`i`番目の列に対応する`TTCatalogColumn`への定数参照を返します。
`getIndex()`	表(`n`が指定された)内の`n`番目の索引に対応する`TTCatalogIndex`オブジェクトへの定数参照を返します。
`getNumColumns()`	表の列数を返します。
`getNumIndexes()`	表の索引数を返します。
`getNumSpecialColumns()`	この表の特殊列の数を返します。TTCatalogSpecialColumnの使用方法を参照してください。
`getSpecialColumn()`	この表から、指定した列番号に従った特殊列(`TTCatalogSpecialColumn`オブジェクト)を返します。
`getTableName()`	表の名前を返します。
`getTableOwner()`	表の所有者を返します。
`getTableType()`	ODBC `SQLTables`関数より返される表タイプを返します。
`isSystemTable()`	表がシステム表の場合は`TRUE`を返します。
`isUserTable()`	表がユーザー表の場合は`TRUE`を返します。

getColumn()

const TTCatalogColumn& getColumn(int cno)

表の列番号cnoと対応するTTCatalogColumnオブジェクトに対する定数参照を返します。このメソッドは、表のすべての列に対する反復処理を容易にするためのものです。

次の関係が成立しています。

0 <= cno < getNumColumns()

getIndex()

const TTCatalogIndex& getIndex(int num)

表の索引番号numと対応するTTCatalogIndexオブジェクトに対する定数参照を返します。このメソッドは、表のすべての索引に対する反復処理を容易にするためのものです。この配列の表の索引の順番は任意です。

次の関係が成立しています。

0 <= num < getNumIndexes()

getNumColumns()

int getNumColumns()

表の列数を返します。

getNumIndexes()

int getNumIndexes()

表の索引数を返します。

getNumSpecialColumns()

int getNumSpecialColumns()

このTTCatalogTableオブジェクト内の特殊列の数を返します。TimesTenでサポートされる特殊列はROWIDのみのため、常に1が返されます。

TTCatalogSpecialColumnの使用方法も参照してください。

getSpecialColumn()

const TTCatalogSpecialColumn& getSpecialColumn(int num) const

このTTCatalogTableオブジェクトから、指定した列番号に従い特殊列(TTCatalogSpecialColumnオブジェクト)を返します。TimesTenでは、これはROWID疑似列のみになります。

TTCatalogSpecialColumnの使用方法も参照してください。

getTableName()

const char* getTableName()

表の名前を返します。

getTableOwner()

const char* getTableOwner()

表の所有者を返します。

getTableType()

const char* getTableType() const

ODBC SQLTablesコールからとして、このTTCatalogTableオブジェクトの表タイプを返します。これは、TimesTenでは、TABLE、SYSTEM TABLE、VIEWまたはSYNONYMになります。

isSystemTable()

bool isSystemTable()

表がシステム表(SYS、TTREPまたはGRIDの所有)の場合TRUEを返し、それ以外の場合はFALSEを返します。

システム表とユーザー表を区別するために、表をフィルタしたり注釈を付けることが可能な、isSystemTable()メソッドとisUserTable()メソッド(次で説明)は、TTCatalog::fetchCatalogData()へのコール後、すべての表を反復するアプリケーションに便利です。TTClassesのデモ・プログラムであるcatalogには、これの実行例があります。(TimesTenクイック・スタートおよびサンプル・アプリケーションについてを参照してください。)

isUserTable()

bool isUserTable()

システム表とは容易に区別ができるユーザー表にはTRUEを返し、それ以外の場合はFALSEを返します。どの表の場合でも、isUserTable()はisSystemTable()と逆の値を返すことに注意してください。isSystemTable()の説明では、これらの方法の使用方法および有用性を説明しています。