About

ドキュメント

Javadocs

プロジェクト文書

Built by Maven

概要

ストアドプロシージャーを呼び出すには、@ProcedureをDaoのメソッドに注釈します。

@Config(config = AppConfig.class)
public interface EmployeeDao {
    @Procedure
    void execute(@Id Integer id, @InOut Reference<BigDecimal> salary);
    ...
}

パラメータには、パラメータの種別を示す@In@InOut@Out@ResultSetのいずれかのアノテーションが必須です。 パラメータは複数指定できます。 戻り値はvoidでなければいけません。

プロシージャー名

デフォルトではメソッド名がプロシージャー名になります。 @Procedurename要素に値を指定した場合は、その値がプロシージャー名になります。

@Procedure(name = "calculateSalary")
void execute(@Id Integer id, @InOut Reference<BigDecimal> salary);

@Procedurecatalog要素やschema要素にカタログ名やスキーマ名を指定できます。 このときプロシージャーの名前はcatalog要素、schema要素、name要素(指定されていなければメソッド名)をピリオドで連結したものになります。

@Procedure(catlog = "CATALOG", schema ="SCHEMA", name = "calculateSalary")
void execute(@Id Integer id, @InOut Reference<BigDecimal> salary);

パラメータ

ストアドプロシージャーのパラメータとDaoメソッドのパラメータの並び順は合わせなければいけません。

INパラメータ

INパラメータは、@Inをメソッドのパラメータに注釈して示します。 パラメータの型が基本型もしくはドメインクラスの場合、引数をnullにできます。 それ以外の型の場合、引数はnullであってはいけません。

@Procedure
void execute(@Id Integer id);

次のように使用します。

EmployeeDao dao = new EmployeeDaoImpl();
dao.execute(1);

INOUTパラメータ

INOUTパラメータは、@InOutをメソッドのパラメータに注釈して示します。 注釈されるパラメータの型はorg.seasar.doma.jdbc.Reference でなければいけません。 Referenceの型パラメータは基本型もしくはドメインクラスでなければいけません。 引数はnullであってはいけません。

@Procedure
void execute(@InOut Reference<BigDecimal> salary);

次のように使用します。

EmployeeDao dao = new EmployeeDaoImpl();
BigDecimal in = new BigDecimal(100);
Reference<BigDecimal> ref = new Reference<BigDecimal>(in);
dao.execute(ref);
BigDecimal out = ref.get();

OUTパラメータ

OUTパラメータは、@Outをメソッドのパラメータに注釈して示します。 注釈されるパラメータの型はorg.seasar.doma.jdbc.Reference でなければいけません。 Referenceの型パラメータは基本型もしくはドメインクラスでなければいけません。 引数はnullであってはいけません。

@Procedure
void execute(@Out Reference<BigDecimal> salary);

次のように使用します。

EmployeeDao dao = new EmployeeDaoImpl();
Reference<BigDecimal> ref = new Reference<BigDecimal>();
dao.execute(ref);
BigDecimal out = ref.get();

カーソルのOUTパラメータもしくは結果セット

カーソルのOUTパラメータ、もしくはストアドファンクションが返す結果セットは、@ResultSetをメソッドのパラメータに注釈して示します。 注釈されるパラメータの型は、基本型ドメインクラスエンティティクラスのいずれかを要素とするjava.util.Listでなければいけません。 引数はnullであってはいけません。

@Procedure
void execute(@ResultSet List<Employee> employee);

次のように使用します。

EmployeeDao dao = new EmployeeDaoImpl();
List<Employee> employees = new ArrayList<Employee>();
dao.execute(employees);
for (Employee e : employees) {
    ...
}