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

インタフェースParameterMetaData

  • すべてのスーパー・インタフェース:
    Wrapper
    public interface ParameterMetaData
extends Wrapper
    PreparedStatementオブジェクト内の各パラメータ・マーカーの型とプロパティに関する情報を取得するのに使用できるオブジェクトです。 クエリーやドライバ実装によっては、ParameterMetaDataオブジェクトによって返されるデータは、PreparedStatementの実行が完了するまで利用できないことがあります。

    ドライバ実装によっては、CallableStatementオブジェクト内の各パラメータ・マーカーの型とプロパティについての情報を提供できないことがあります。

    導入されたバージョン:
    1.4

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static int parameterModeIn
      パラメータのモードがINであることを示す定数です。
      static int parameterModeInOut
      パラメータのモードがINOUTであることを示す定数です。
      static int parameterModeOut
      パラメータのモードがOUTであることを示す定数です。
      static int parameterModeUnknown
      パラメータのモードが不明であることを示す定数です。
      static int parameterNoNulls
      パラメータがNULL値を許可しないことを示す定数です。
      static int parameterNullable
      パラメータがNULL値を許可することを示す定数です。
      static int parameterNullableUnknown
      パラメータがNULL値を許可するかどうか不明であることを示す定数です。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 
      修飾子と型 メソッド 説明
      String getParameterClassName​(int param)
      インスタンスがPreparedStatement.setObjectメソッドに渡されるJavaクラスの完全指定された名前を取得します。
      int getParameterCount()
      このParameterMetaDataオブジェクトが情報を含むPreparedStatement内のパラメータの数を取得します。
      int getParameterMode​(int param)
      指定されたパラメータのモードを取得します。
      int getParameterType​(int param)
      指定されたパラメータのSQL型を取得します。
      String getParameterTypeName​(int param)
      指定されたパラメータのデータベース固有の型名を取得します。
      int getPrecision​(int param)
      指定されたパラメータに指定された列のサイズを取得します。
      int getScale​(int param)
      指定されたパラメータの小数点以下の桁数を取得します。スケールが適用できないデータ型の場合は、0が返されます。
      int isNullable​(int param)
      指定されたパラメータでnull値が許可されるかどうかを取得します。
      boolean isSigned​(int param)
      指定されたパラメータの値が符号付き数値かどうかを取得します。

    • フィールドの詳細

      • parameterNoNulls

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

      • parameterNullable

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

      • parameterNullableUnknown

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

      • parameterModeUnknown

        static final int parameterModeUnknown
        パラメータのモードが不明であることを示す定数です。
        関連項目:
        定数フィールド値

      • parameterModeIn

        static final int parameterModeIn
        パラメータのモードがINであることを示す定数です。
        関連項目:
        定数フィールド値

      • parameterModeInOut

        static final int parameterModeInOut
        パラメータのモードがINOUTであることを示す定数です。
        関連項目:
        定数フィールド値

      • parameterModeOut

        static final int parameterModeOut
        パラメータのモードがOUTであることを示す定数です。
        関連項目:
        定数フィールド値

    • メソッドの詳細

      • getParameterCount

        int getParameterCount()
               throws SQLException
        このParameterMetaDataオブジェクトが情報を含むPreparedStatement内のパラメータの数を取得します。
        戻り値:
        パラメータの数
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4

      • isNullable

        int isNullable​(int param)
        throws SQLException
        指定されたパラメータでnull値が許可されるかどうかを取得します。
        パラメータ:
        param - 最初のパラメータは1、2番目のパラメータは2、... となる
        戻り値:
        指定されたパラメータにNULL値が許可されるかどうか。ParameterMetaData.parameterNoNulls、ParameterMetaData.parameterNullable、ParameterMetaData.parameterNullableUnknownのいずれか1つ
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4

      • isSigned

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

      • getPrecision

        int getPrecision​(int param)
          throws SQLException
        指定されたパラメータに指定された列のサイズを取得します。

        戻り値は、そのパラメータに指定された列の最大サイズを表します。 数値データの場合は、最大精度です。 文字データの場合は、文字数です。 日時データ型の場合は、String表現の文字数です(小数点以下の秒の構成要素の最大許容精度を仮定)。 バイナリ・データの場合は、バイト数です。 ROWIDデータ型の場合は、バイト数です。列サイズが適用できないデータ型の場合は、0が返されます。

        パラメータ:
        param - 最初のパラメータは1、2番目のパラメータは2、... となる
        戻り値:
        precision
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4

      • getScale

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

      • getParameterType

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

      • getParameterTypeName

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

      • getParameterClassName

        String getParameterClassName​(int param)
                      throws SQLException
        インスタンスがPreparedStatement.setObjectメソッドに渡されるJavaクラスの完全指定された名前を取得します。
        パラメータ:
        param - 最初のパラメータは1、2番目のパラメータは2、... となる
        戻り値:
        指定されたパラメータの値を設定するためにPreparedStatement.setObjectメソッドによって使用されるJavaプログラミング言語のクラスの完全指定された名前。 カスタム・マッピングに使用されるクラス名
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4

      • getParameterMode

        int getParameterMode​(int param)
              throws SQLException
        指定されたパラメータのモードを取得します。
        パラメータ:
        param - 最初のパラメータは1、2番目のパラメータは2、... となる
        戻り値:
        パラメータのモード。ParameterMetaData.parameterModeIn、ParameterMetaData.parameterModeOut、またはParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknownのいずれか。
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4