JavaTM Platform
Standard Ed. 6

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)
          指定されたパラメータの小数点以下の桁数を取得します。
 int isNullable(int param)
          指定されたパラメータで null 値が許可されるかどうかを取得します。
 boolean isSigned(int param)
          指定されたパラメータの値が符号付き数値かどうかを取得します。
 
インタフェース java.sql.Wrapper から継承されたメソッド
isWrapperFor, unwrap
 

フィールドの詳細

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.parameterNoNullsParameterMetaData.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、... となる
戻り値:
精度
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getScale

int getScale(int param)
             throws SQLException
指定されたパラメータの小数点以下の桁数を取得します。スケールが適用できないデータ型の場合は、0 が返されます。

パラメータ:
param - 最初のパラメータは 1、2 番目のパラメータは 2、... となる
戻り値:
スケール (桁数)
例外:
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.parameterModeInParameterMetaData.parameterModeOutParameterMetaData.parameterModeInOut、または ParameterMetaData.parameterModeUnknown のうちの 1 つ
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。