org.seasar.doma

注釈型 ResultSet

@Target(value=PARAMETER)
 @Retention(value=RUNTIME)
public @interface ResultSet

ストアドファンクションやストアドプロシージャーから返される結果セットにマッピングされることを示します。

ResultSet をカーソルとしてOUTパラメータで返すRDBMSにおいては、注釈されたパラメータは実質的にOUTパラメータとして扱われます 。そうでないRDBMSにおいては、IN、INOUT、OUTのいずれのパラメータにもみなされません。 Statement.getResultSet()で取得される結果セットにマッピングされます。

このアノテーションが注釈されるパラメータは、 Function もしくは Procedure が注釈されたメソッドのパラメータでなければいけません。

例:

 @Dao(config = AppConfig.class)
 public interface EmployeeDao {
 
     @Procedure
     void fetchEmployees(@In Integer departmentId,
             @ResultSet List<Employee> employees);
 }
 

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

任意要素の概要

任意要素

修飾子とタイプ	任意要素と説明
boolean	ensureResultMapping 結果がエンティティやエンティティのリストの場合、 エンティティのすべてのプロパティに結果セットのカラムがマッピングされることを保証するかどうかを返します。

要素の詳細

ensureResultMapping

public abstract boolean ensureResultMapping

結果がエンティティやエンティティのリストの場合、 エンティティのすべてのプロパティに結果セットのカラムがマッピングされることを保証するかどうかを返します。

true の場合、マッピングされないプロパティが存在すれば、このアノテーションが注釈されたパラメータを持つメソッドから ResultMappingException がスローされます。

戻り値:

保証するかどうか

導入されたバージョン:

1.34.0

デフォルト:

false