モジュール java.sql
パッケージ java.sql

インタフェースResultSetMetaData

  • すべてのスーパー・インタフェース:
    Wrapper
    既知のすべてのサブインタフェース:
    RowSetMetaData
    既知のすべての実装クラス:
    RowSetMetaDataImpl

    public interface ResultSetMetaData
extends Wrapper
    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);
    導入されたバージョン:
    1.1

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static int columnNoNulls
      列がNULL値を許可しないことを示す定数です。
      static int columnNullable
      列がNULL値を許可することを示す定数です。
      static int columnNullableUnknown
      列がNULL値を許可するかどうか不明であることを示す定数です。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 
      修飾子と型 メソッド 説明
      String getCatalogName​(int column)
      指定された列の表のカタログ名を取得します。
      String getColumnClassName​(int column)
      Javaクラスの完全指定された名前を返します。列から値を検索するためにResultSet.getObjectメソッドが呼び出されると、この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)
      指定された列に指定された列のサイズを取得します。
      int getScale​(int column)
      指定された列の小数点以下の桁数を取得します。スケールが適用できないデータ型の場合は、0が返されます。
      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

        static final int columnNoNulls
        列がNULL値を許可しないことを示す定数です。
        関連項目:
        定数フィールド値

      • columnNullable

        static final int columnNullable
        列がNULL値を許可することを示す定数です。
        関連項目:
        定数フィールド値

      • columnNullableUnknown

        static final int columnNullableUnknown
        列がNULL値を許可するかどうか不明であることを示す定数です。
        関連項目:
        定数フィールド値

    • メソッドの詳細

      • getColumnCount

        int getColumnCount​()
            throws SQLException
        このResultSetオブジェクトの列数を返します。
        戻り値:
        列数
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isAutoIncrement

        boolean isAutoIncrement​(int column)
                 throws SQLException
        指定された列が自動的に番号付けされるかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isCaseSensitive

        boolean isCaseSensitive​(int column)
                 throws SQLException
        列の大文字小文字が区別されるかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isSearchable

        boolean isSearchable​(int column)
              throws SQLException
        指定された列をwhere節で使用できるかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isCurrency

        boolean isCurrency​(int column)
            throws SQLException
        指定された列がキャッシュの値かどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isNullable

        int isNullable​(int column)
        throws SQLException
        指定された列にNULL値が許可されるかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        指定された列にNULL値が許可されるかどうか。columnNoNulls、columnNullable、columnNullableUnknownのいずれか1つ
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isSigned

        boolean isSigned​(int column)
          throws SQLException
        指定された列の値が符号付き数値かどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getColumnDisplaySize

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

      • getColumnLabel

        String getColumnLabel​(int column)
               throws SQLException
        印刷や表示に使用する、指定された列の推奨タイトルを取得します。 通常、推奨タイトルは、SQL AS節として指定されます。 SQL ASが指定されていない場合、getColumnLabelから返される値は、getColumnNameメソッドによって返される値と同じになります。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        列の推奨タイトル
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getColumnName

        String getColumnName​(int column)
              throws SQLException
        指定された列の名前を取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        列名
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getSchemaName

        String getSchemaName​(int column)
              throws SQLException
        指定された列の表のスキーマを取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        スキーマ名。適用不可の場合は""
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getPrecision

        int getPrecision​(int column)
          throws SQLException
        指定された列に指定された列のサイズを取得します。 数値データの場合は、最大精度です。 文字データの場合は、文字数です。 日時データ型の場合は、String表現の文字数です(小数点以下の秒の構成要素の最大許容精度を仮定)。 バイナリ・データの場合は、バイト数です。 ROWIDデータ型の場合は、バイト数です。列サイズが適用できないデータ型の場合は、0が返されます。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        精度
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getScale

        int getScale​(int column)
      throws SQLException
        指定された列の小数点以下の桁数を取得します。スケールが適用できないデータ型の場合は、0が返されます。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        スケール(桁数)
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getTableName

        String getTableName​(int column)
             throws SQLException
        指定された列の表名を取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        表名。適用不可の場合は""
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getCatalogName

        String getCatalogName​(int column)
               throws SQLException
        指定された列の表のカタログ名を取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        指定された列が現れる表のカタログ名。適用不可の場合は""
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getColumnType

        int getColumnType​(int column)
           throws SQLException
        指定された列のSQL型を取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        java.sql.TypesからのSQL型
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        関連項目:
        Types

      • getColumnTypeName

        String getColumnTypeName​(int column)
                  throws SQLException
        指定された列のデータベース固有の型名を取得します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        データベースが使用する型名。 列の型がユーザー定義型の場合は、完全指定された型名
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isReadOnly

        boolean isReadOnly​(int column)
            throws SQLException
        指定された列が絶対的に書込み可能でないかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isWritable

        boolean isWritable​(int column)
            throws SQLException
        指定された列への書込みを成功させることができるかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • isDefinitelyWritable

        boolean isDefinitelyWritable​(int column)
                      throws SQLException
        指定された列の書込みが必ず成功するかどうかを示します。
        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        上記の場合はtrue、そうでない場合はfalse
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合

      • getColumnClassName

        String getColumnClassName​(int column)
                   throws SQLException

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

        パラメータ:
        column - 最初の列は1、2番目の列は2、... となる
        戻り値:
        指定された列の値を取り出すためにResultSet.getObjectメソッドによって使用されるJavaプログラミング言語のクラスの完全指定された名前。 カスタム・マッピングに使用されるクラス名
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.2