クラス com.ibm.etools.sqltoxml.QueryProperties

java.lang.Object
        com.ibm.etools.sqltoxml.BaseProperties |
                com.ibm.etools.sqltoxml.QueryProperties

パブリック最終クラス QueryProperties は BaseProperties を拡張します。

このクラスは、SQLToXML がその SQL 照会を実行するのに必要な情報を提供し、その他のいくつかの成果物と共に XML ファイルを生成します。情報は、手動による方法、または (通常は .xst 拡張 子付きの) 照会ファイル からロードする方法のいずれかで設定することができます。さらに、情報はを照会ファイルに保管することもできます。

関連事項
SQLToXML
表 1. コンストラクター・インデックス
コンストラクター 説明
QueryProperties() デフォルト・コンストラクター。
表 2. メソッド・インデックス
メソッド 説明
String getEncoding() プロパティー・ファイルの Java™ スタイル・エンコード値を戻す。
String getEncodingTag() store() が呼び出された場合、書き込まれるプロパティー・ファイ ルのエンコード値を戻す。
String getFormat() フォーマット・オプションを戻す。
String getJdbcDriver() JDBC ドライバー名を戻す。
String getJdbcServer() JDBC サーバー・パスを戻す。
String getLoginId() 照会を実行する適切な特権を持つデータベース・ユーザー ID を戻す。
String getPassword() 照会を実行する適切な特権を持つユーザー ID のパスワードを戻す。
Boolean getRecurse() 現行の照会から外部キー列が検出されたときに、ターゲット・テーブルでも照会を実行する必要があるかどうかを示すブール値を戻す。
String getStatement() 実行する現行の SQL ステートメントを戻す。
Vector getVarTypes()  推奨されない 使用されると、代替のパラメーター・タイプのシーケンスを戻す。
void load(InputStream) InputStream から必要な照会値をロードする。
void load(String) 照会ファイルから必要な照会値をロードする。
void setEncoding(String) store() が呼び出された場合に書き込まれるプロパティー・ファイ ルに、Java スタイル・エンコード値を設定する。
void setEncodingTag(String) store() が呼び出された場合に書き込まれるプロパティー・ファイルに、 エンコード値を設定する。
void setFormat(String) フォーマット・オプションを設定する。
void setJdbcDriver(String) JDBC ドライバー名を設定する。
void setJdbcServer(String) JDBC サーバー・パスを設定する。
void setLoginId(String) 照会を実行するための特権を持つ、データベース・ユーザー ID を 設定する。
void setPassword(String) 照会を実行する特権を持つユーザー ID のパスワードを設定する。
void setRecurse(Boolean) 現行の照会から外部キー列が検出されたとき、ターゲット・テーブルでも照会を実行する必要かあるかについて示すブール値を設定する。
void setStatement(String) 現行の SQL ステートメントを設定する。
void setVarTypes(Vector) Deprecated. VarTypes は、SQL ステートメントが「?」などの置換パラメー ターを含み、ユーザーがそれらのパラメーターについて明示的にデータ・タイプを示したい場合に使用される。
void store(String) 必要な照会値を照会ファイルに保管する。

コンストラクター

QueryProperties
public QueryProperties()

デフォルト・コンストラクター。

メソッド

getEncoding
public String getEncoding()

プ ロパティー・ファイルの Java スタイル・エンコード値を戻します。

getEncodingTag
public java.lang.String getEncodingTag()

store() が 呼び出された場合に書き込まれるプロパティー・ファイルのエンコード値を戻します。

getFormat
public String getFormat()

フォーマット・オプションを戻します。選択可能な出力フォーマットは以下のとおりです。

   SQLGenerateOptions.GENERATE_AS_ELEMENTS,
   SQLGenerateOptions.GENERATE_AS_ATTRIBUTES,
   SQLGenerateOptions.GENERATE_PRIMARYKEYS_AS_ATTRIBUTES, and
   SQLGenerateOptions.GENERATE_ID_AND_IDREF
getJdbcDriver
public java.lang.String getJdbcDriver()

JDBC ドライバー名を戻す。ドライバー引数フォームの例は以下のとおりです。

   COM.ibm.db2.jdbc.app.DB2Driver
getJdbcServer
public java.lang.String getJdbcServer()

JDBC サーバー・パスを戻す。サーバー引数フォームの例は以下のとおりです。

   jdbc:db2:hospital

ここで hospital は、照会のデータベース名です。

getLoginId
public java.lang.String getLoginId()

照会 を実行する特権を持つデータベース・ユーザー ID を戻します。

getPassword
public java.lang.String getPassword()

照会 を実行する適切な特権を持つユーザー ID のパスワードを戻します。

getRecurse
public Boolean getRecurse()

現行の照会から外部キー列を検出されたとき、ターゲット・テーブルでも照会を実行する必要があるかについてを示すブール値を戻します。

getStatement
public String getStatement()

実行 される現行の SQL ステートメントを戻します。

getVarTypes
public java.util.Vector getVarTypes()

推奨されない使用されると、置換パラメーター・タイプのシーケンスを戻します。VarTypes は 、SQL ステートメントが「?」などの置換パラメーターを含み、ユーザーが、それらのパラメーターについて明示的にデータ・タイプを示したい場合に使用されます。

ロード
public void load(InputStream stream) throws Exception

InputStream から必要な照会値をロードします。InputStream の 内容は、照会ファイルのフォーマットに対応した XML フォーマットです。

ロード
public void load(String xstFilename) throws Exception

照会ファイルから必要な照会値をロードします。照会ファイル名は、.xst 拡張子を使用します。

setEncoding
public void setEncoding(String enc)

store() が呼び出された場合に書き込まれるプロパティー・ファイルに 、Java スタイル・エンコード値を設定します。

setEncodingTag
public void setEncodingTag(String encTag)

store() が 呼び出された場合に書き込まれるプロパティー・ファイルにエンコード値を設定します。

setFormat
public void setFormat(String newFormat)

フォーマット・オプションを設定します。選択可能な出力フォーマットは以下のとおりです。

   GENERATE_AS_ELEMENTS,
   GENERATE_AS_ATTRIBUTES,
   GENERATE_PRIMARYKEYS_AS_ATTRIBUTES, and
   GENERATE_ID_AND_IDREF
setJdbcDriver
public void setJdbcDriver(String newJdbcDriver)

JDBC ドライバー名を設定します。ドライバー引数フォームの例は以下のとおりです。

   COM.ibm.db2.jdbc.app.DB2Driver
setJdbcServer
public void setJdbcServer(String newJdbcServer)

JDBC サ ーバー・パスを設定します。サーバー引数フォームの例は以下のとおりです。

   jdbc:db2:hospital

ここで hospital は、照会のデータベース名です。

setLoginId
public void setLoginId(String newLoginId)

照会 を実行する特権を持つ、データベース・ユーザー ID を設定します。

setPassword
public void setPassword(String newPassword)

照会 を実行する特権を持つユーザー ID のパスワードを設定します。

setRecurse
public void setRecurse(Boolean newRecurse)

現行の照会から外部キー列が検出されたときに、ターゲット・テーブルでも照会を実行する必要があるかについて示すブール値を設定します。

setStatement
public void setStatement(String newStatement)

現行の SQL ステートメントを設定します。

setVarTypes
public void setVarTypes(Vector types)

推奨されないVarTypes は、SQL ステートメントが「?」などの置換パラメーターを 含み、ユーザーがそれらのパラメーターについてデータ・タイプを明示的に示したい場合に使用されます。

保管
public void store(String xstFilename) throws Exception

必 要な照会値を照会ファイルに保管します。照会ファイル名は .xst 拡張子を使用します。

関連資料
クラス com.ibm.etools.sqltoxml.SQLToXML
クラス com.ibm.etools.sqltoxml.BaseProperties
フィードバック
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.