org.seasar.doma
注釈型 BatchUpdate


@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface BatchUpdate

バッチ更新処理を示します。

このアノテーションが注釈されるメソッドは、Dao が注釈されたインタフェースのメンバでなければいけません。 注釈されるメソッドは、次の制約を満たす必要があります。

例:
 @Entity
 public class Employee {
     ...
 }
 
 @Dao(config = AppConfig.class)
 public interface EmployeeDao {
 
     @BatchUpdate
     int[] update(List<Employee> employee);
 }
 
注釈されるメソッドは、次の例外をスローすることがあります。

作成者:
taedium

任意要素の概要
 String[] exclude
          UPDATE文のSET句から除外するプロパティ名の配列です。
 String[] include
          UPDATE文のSET句に含めるプロパティ名の配列です。
 boolean includeVersion
          UPDATE文のSET句にバージョン番号を含めるかどうかを示します。
 int queryTimeout
          クエリタイムアウト(秒)です。
 boolean sqlFile
          SQLファイルにマッピングするかどうかを示します。
 boolean suppressOptimisticLockException
          更新結果が1件でない場合にスローされる OptimisticLockExceptionを抑制するかどうかを示します。
 

sqlFile

public abstract boolean sqlFile
SQLファイルにマッピングするかどうかを示します。

デフォルト:
false

queryTimeout

public abstract int queryTimeout
クエリタイムアウト(秒)です。

指定しない場合、Config.getQueryTimeout()が使用されます。

関連項目:
Statement.setQueryTimeout(int)
デフォルト:
-1

includeVersion

public abstract boolean includeVersion
UPDATE文のSET句にバージョン番号を含めるかどうかを示します。

デフォルト:
false

include

public abstract String[] include
UPDATE文のSET句に含めるプロパティ名の配列です。

ここに指定できるのは、カラム名ではなくプロパティ名です。 プロパティ名とは、カラムにマッピングされたエンティティのメソッド名のことです。

デフォルト:
{}

exclude

public abstract String[] exclude
UPDATE文のSET句から除外するプロパティ名の配列です。

ここに指定できるのは、カラム名ではなくプロパティ名です。 プロパティ名とは、カラムにマッピングされたエンティティのメソッド名のことです。

デフォルト:
{}

suppressOptimisticLockException

public abstract boolean suppressOptimisticLockException
更新結果が1件でない場合にスローされる OptimisticLockExceptionを抑制するかどうかを示します。

デフォルト:
false


Copyright © 2009-2010 The Seasar Foundation. All Rights Reserved.