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

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

public final class 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) 推奨されない 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、および
   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 フォーマットに等価の 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、および
   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, 2004. All Rights Reserved. (C) Copyright IBM Japan 2005