JDBC コントロールは、リレーショナル データベースへのアクセスを提供します。JDBC コントロールに追加するメソッドは、データベースに対して SQL コマンドを実行します。このトピックでは、JDBC コントロールにメソッドを追加する手順を説明します。
JDBC コントロールのメソッドには、関連付けられた SQL 文が必ずあります。メソッドが呼び出されると、この SQL 文がデータベースに対して実行されます。メソッドの @JdbcControl.SQL アノテーションは、メソッドの SQL 文を示します。
JDBC コントロールを作成すると、コメント ヘッダに以下のようなサンプル メソッドが挿入されます。
@JdbcControl.SQL(statement="SELECT ID, NAME FROM CUSTOMERS WHERE ID = {id}")
Customer findCustomer(int id) throws SQLException;
メソッドの SQL 文には、置換パラメータが含まれている場合があります。置換パラメータは、実行時にメソッドに渡される値に置き換えられます。Workshop でどのパラメータをどの値に置き換えるかを認識できるように、SQL 文内の置換パラメータ名はメソッド シグネチャのパラメータ名と一致している必要があります。SQL 文では、置換パラメータは中括弧で囲まれています。
上の例の場合、SQL 文には {id} という置換パラメータが含まれています。これは、findCustomer メソッドの id パラメータにマップされます。メソッドを呼び出すと、参照先のパラメータの値が代入されてから SQL 文が実行されます。置換パラメータでは大文字と小文字が区別されるので、置換するパラメータのスペルおよび大文字と小文字の区別はメソッドのパラメータと正確に一致しなければなりません。
メソッド シグネチャでは、このコントロールのユーザが呼び出し可能なメソッドを宣言します。このコントロールを使用するアプリケーションの開発者に便利で役立つ引数と戻り値となるように、このメソッドを設計する必要があります。
JDBC コントロール メソッドの SQL 文のパラメータ置換の規則については、『JDBC コントロールのドキュメント』を参照してください。
データベースのオペレーションの戻り値の型は、Java メソッドの戻り値の型によって決まります。Workshop は、返されるメソッドで指定した型に従って結果をフォーマットしようとします。
JDBC コントロールのメソッドは、単一の値、単一行、または複数行を返すことができます。JDBC コントロールのメソッドの戻り値については、『JDBC コントロールのドキュメント』を参照してください。