JavaTM 2 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)
          獲取 Java 類別的完全限定名稱,該類別的實例應該傳遞給 PreparedStatement.setObject 方法。
 int getParameterCount()
          獲取 PreparedStatement 物件中的參數的數量,此 ParameterMetaData 物件包含了該物件的資訊。
 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
獲取 PreparedStatement 物件中的參數的數量,此 ParameterMetaData 物件包含了該物件的資訊。

返回:
參數的數量
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

isNullable

int isNullable(int param)
               throws SQLException
獲取是否允許在指定參數中使用 null 值。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
給定參數的狀態是否可為 null,該狀態值是 ParameterMetaData.parameterNoNullsParameterMetaData.parameterNullableParameterMetaData.parameterNullableUnknown 之一
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

isSigned

boolean isSigned(int param)
                 throws SQLException
獲取指定參數的值是否可以是帶符號的數字。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
如果是這樣,則返回 true;否則返回 false
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

getPrecision

int getPrecision(int param)
                 throws SQLException
獲取指定參數的指定列大小。

返回值表示給定參數的最大列大小。對於數值資料,這是最大精度。對於字元資料,這是字元長度。對於日期時間資料型別,這是 String 表示形式的字元長度(假定允許的最大小數秒元件的精度)。對於二進制資料,這是位元組長度。對於 ROWID 資料型別,這是位元組長度。對於列大小不可用的資料型別,則返回 0。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
精度
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

getScale

int getScale(int param)
             throws SQLException
獲取指定參數的小數點右邊的位數。對於標度不可用的資料型別,則返回 0。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
精度
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

getParameterType

int getParameterType(int param)
                     throws SQLException
獲取指定參數的 SQL 型別。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
來自 java.sql.Types 的 SQL 型別
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4
另請參見:
Types

getParameterTypeName

String getParameterTypeName(int param)
                            throws SQLException
獲取指定參數的特定於資料庫的型別名稱。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
資料庫使用的型別名稱。如果參數型別是使用者定義的型別,則返回完全限定的型別名稱。
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

getParameterClassName

String getParameterClassName(int param)
                             throws SQLException
獲取 Java 類別的完全限定名稱,該類別的實例應該傳遞給 PreparedStatement.setObject 方法。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
Java 程式語言中的類別的完全限定名稱,方法 PreparedStatement.setObject 將使用該名稱設置指定參數中的值。此為用於自定義映射關係的類別名稱。
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

getParameterMode

int getParameterMode(int param)
                     throws SQLException
獲取指定參數的網要。

參數:
param - 第一個參數是 1,第二個參數是 2,……
返回:
參數的網要,該網要是 ParameterMetaData.parameterModeInParameterMetaData.parameterModeOutParameterMetaData.parameterModeInOutParameterMetaData.parameterModeUnknown 之一。
拋出:
SQLException - 如果發生資料庫存取錯誤
從以下版本開始:
1.4

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only