Java 2 Platform SE 1.3: インタフェース ResultSetMetaData

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Std. Ed. v1.3

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

java.sql
インタフェース ResultSetMetaData

public interface ResultSetMetaData

ResultSet オブジェクトの列のタイプとプロパティに関する情報を取得するのに使用できるオブジェクトです。次のコードフラグメントは、ResultSet オブジェクトの rs を生成し、ResultSetMetaData オブジェクトの rsmd を生成し、rsmd を使用して、rs が持っている列の数と、rs にある最初の列を WHERE 節に使用できるかどうかを判別します。


     ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2");
     ResultSetMetaData rsmd = rs.getMetaData();
     int numberOfColumns = rsmd.getColumnCount();
     boolean b = rsmd.isSearchable(1);

フィールドの概要

static int columnNoNulls
          列が NULL 値を許可しないことを示す定数です。

static int columnNullable
          列が NULL 値を許可することを示す定数です。

static int columnNullableUnknown
          列が NULL 値を許可するかどうか不明であることを示す定数です。

メソッドの概要

String getCatalogName(int column)
          指定された列のテーブルのカタログ名を取得します。

String getColumnClassName(int column)
          Java クラスの完全指定された名前を返します。

int getColumnCount()
          この ResultSet オブジェクトの列数を返します。

int getColumnDisplaySize(int column)
          指定された列の通常の最大幅を文字数で示します。

String getColumnLabel(int column)
          印刷や表示に使用する、指定された列の推奨タイトルを取得します。

String getColumnName(int column)
          指定された列の名前を取得します。

int getColumnType(int column)
          指定された列の SQL 型を取得します。

String getColumnTypeName(int column)
          指定された列のデータベース固有の型名を取得します。

int getPrecision(int column)
          指定された列の 10 進桁数を取得します。

int getScale(int column)
          指定された列の小数点以下の桁数を取得します。

String getSchemaName(int column)
          指定された列のテーブルのスキーマを取得します。

String getTableName(int column)
          指定された列のテーブル名を取得します。

boolean isAutoIncrement(int column)
          指定された列が自動的に番号付けされて読み込み専用として扱われるかどうかを示します。

boolean isCaseSensitive(int column)
          列の大文字小文字が区別されるかどうかを示します。

boolean isCurrency(int column)
          指定された列がキャッシュの値かどうかを示します。

boolean isDefinitelyWritable(int column)
          指定された列の書き込みが必ず成功するかどうかを示します。

int isNullable(int column)
          指定された列に NULL をセットできるかどうかを示します。

boolean isReadOnly(int column)
          指定された列が絶対的に書き込み可能でないかどうかを示します。

boolean isSearchable(int column)
          指定された列を where 節で使用できるかどうかを示します。

boolean isSigned(int column)
          指定された列の値が符号付き数値かどうかを示します。

boolean isWritable(int column)
          指定された列への書き込みを成功させることができるかどうかを示します。

フィールドの詳細

columnNoNulls

public static final int columnNoNulls

列が NULL 値を許可しないことを示す定数です。

columnNullable

public static final int columnNullable

列が NULL 値を許可することを示す定数です。

columnNullableUnknown

public static final int columnNullableUnknown

列が NULL 値を許可するかどうか不明であることを示す定数です。

メソッドの詳細

getColumnCount

public int getColumnCount()
                   throws SQLException

この ResultSet オブジェクトの列数を返します。

戻り値:: 列数
例外:: SQLException - データベースアクセスエラーが発生した場合

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws SQLException

指定された列が自動的に番号付けされて読み込み専用として扱われるかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws SQLException

列の大文字小文字が区別されるかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isSearchable

public boolean isSearchable(int column)
                     throws SQLException

指定された列を where 節で使用できるかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isCurrency

public boolean isCurrency(int column)
                   throws SQLException

指定された列がキャッシュの値かどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isNullable

public int isNullable(int column)
               throws SQLException

指定された列に NULL をセットできるかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 指定された列に NULL をセットできるかどうか。columnNoNulls、columnNullable、columnNullableUnknown のどれか 1 つ
例外:: SQLException - データベースアクセスエラーが発生した場合

isSigned

public boolean isSigned(int column)
                 throws SQLException

指定された列の値が符号付き数値かどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws SQLException

指定された列の通常の最大幅を文字数で示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 指定された列の幅として許可される通常の最大文字数
例外:: SQLException - データベースアクセスエラーが発生した場合

getColumnLabel

public String getColumnLabel(int column)
                      throws SQLException

印刷や表示に使用する、指定された列の推奨タイトルを取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 列の推奨タイトル
例外:: SQLException - データベースアクセスエラーが発生した場合

getColumnName

public String getColumnName(int column)
                     throws SQLException

指定された列の名前を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 列名
例外:: SQLException - データベースアクセスエラーが発生した場合

getSchemaName

public String getSchemaName(int column)
                     throws SQLException

指定された列のテーブルのスキーマを取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: スキーマ名。適用不可の場合は、""
例外:: SQLException - データベースアクセスエラーが発生した場合

getPrecision

public int getPrecision(int column)
                 throws SQLException

指定された列の 10 進桁数を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 精度
例外:: SQLException - データベースアクセスエラーが発生した場合

getScale

public int getScale(int column)
             throws SQLException

指定された列の小数点以下の桁数を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: スケール (桁数)
例外:: SQLException - データベースアクセスエラーが発生した場合

getTableName

public String getTableName(int column)
                    throws SQLException

指定された列のテーブル名を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: テーブル名。適用不可の場合は、""
例外:: SQLException - データベースアクセスエラーが発生した場合

getCatalogName

public String getCatalogName(int column)
                      throws SQLException

指定された列のテーブルのカタログ名を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 列名。適用不可の場合は、""
例外:: SQLException - データベースアクセスエラーが発生した場合

getColumnType

public int getColumnType(int column)
                  throws SQLException

指定された列の SQL 型を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: java.sql.Types からの SQL 型
例外:: SQLException - データベースアクセスエラーが発生した場合
関連項目:: Types

getColumnTypeName

public String getColumnTypeName(int column)
                         throws SQLException

指定された列のデータベース固有の型名を取得します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: データベースが使用する型名。列の型がユーザ定義型の場合は、完全指定された型名
例外:: SQLException - データベースアクセスエラーが発生した場合

isReadOnly

public boolean isReadOnly(int column)
                   throws SQLException

指定された列が絶対的に書き込み可能でないかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isWritable

public boolean isWritable(int column)
                   throws SQLException

指定された列への書き込みを成功させることができるかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws SQLException

指定された列の書き込みが必ず成功するかどうかを示します。

パラメータ:: column - 最初の列は 1、2 番目の列は 2、などとする
戻り値:: 上記の場合は true、そうでない場合は false
例外:: SQLException - データベースアクセスエラーが発生した場合

getColumnClassName

public String getColumnClassName(int column)
                          throws SQLException

Java クラスの完全指定された名前を返します。列から値を検索するために ResultSet.getObject メソッドが呼び出されると、この Java クラスのインスタンスが生成されます。ResultSet.getObject は、このメソッドで返されたクラスのサブクラスを返す場合もあります。

戻り値:: 指定された列の値を取り出すために ResultSet.getObject メソッドによって使用される Java プログラミング言語のクラスの完全指定された名前。カスタムマッピングに使用されるクラス名
例外:: SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:: 1.2
関連項目:: 「JDBC 2.0 API に含まれるもの」

概要