The Seasar Project

エンティティリスナー

エンティティがデータベースに対し挿入、更新、削除される直前/直後に処理を実行したい場合、 listener 要素に org.seasar.doma.jdbc.entity.EntityListener の実装クラスを指定できます。

@Entity(listener = EmployeeEntityListener.class)
public class Employee {
    ...
}

listener 要素に何も指定しない場合、エンティティクラスが他のエンティティクラスを継承しているかどうかで採用する設定が変わります。

• 継承している場合、親エンティティクラスの設定を引き継ぎます
• 継承していない場合、何も行いません（org.seasar.doma.jdbc.entity.NullEntityListener が使用されます）

EntityListenerは、preDelete、preInsert、preUpdate、postDelete、postInsert、postUpdateの6つのメソッドをもったインタフェースです。

preDelete

@Delete、または@BatchDeleteが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、削除処理の直前に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

preInsert

@Insert、または@BatchInsertが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、挿入処理の直前に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

preUpdate

@Update、または@BatchUpdateが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、更新処理の直前に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

postDelete

@Delete、または@BatchDeleteが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、削除処理の直後に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

postInsert

@Insert、または@BatchInsertが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、挿入処理の直後に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

postUpdate

@Update、または@BatchUpdateが注釈されたDaoメソッドでパラメータにエンティティが含まれる場合、更新処理の直後に呼び出されます。 ただし、使用するエンティティクラスにエンティティリスナーが指定されている必要があります。

EntityListenerは次のように実装できます。

public class EmployeeEntityListener implements EntityListener<Employee> {
    @Override
    public void preDelete(Employee entity, PreDeleteContext<Employee> context) {
        ...
    }
    @Override
    public void preInsert(Employee entity, PreInsertContext<Employee> context) {
        ...
    }
    @Override
    public void preUpdate(Employee entity, PreUpdateContext<Employee> context) {
        ...
    }
    @Override
    public void postDelete(Employee entity, PostDeleteContext<Employee> context) {
        ...
    }
    @Override
    public void postInsert(Employee entity, PostInsertContext<Employee> context) {
        ...
    }
    @Override
    public void postUpdate(Employee entity, PostUpdateContext<Employee> context) {
        ...
    }
}

EntityListenerの各メソッドの2番目のパラメータは挿入、更新、削除が行われた場合のコンテキスト情報です。 このコンテキスト情報には、エンティティのメタクラス、Daoのメソッド、Daoの設定が含まれます。 たとえば、Daoのメソッドに独自のアノテーションをつけておくと、そのアノテーションの有無を見て特定のプロパティを更新するといったことが可能です。

EntityListenerの実装クラスはpublicなデフォルトコンストラクタ（引数なしのコンストラクタ）を持たねばいけません。

ネーミング規約

エンティティに対応するテーブル名やプロパティに対応するカラム名を解決するためのネーミング規約を変更したい場合、 naming 要素に org.seasar.doma.jdbc.entity.NamingType の列挙型を指定できます。

@Entity(naming = NamingType.SNAKE_UPPER_CASE)
public class EmployeeInfo {
    ...
}

naming 要素に何も指定しない場合、エンティティクラスが他のエンティティクラスを継承しているかどうかで採用する設定が変わります。

• 継承している場合、親エンティティクラスの設定を引き継ぎます
• 継承していない場合、何も行いません（org.seasar.doma.jdbc.entity.NamingType.NONE が使用されます）

NamingType.SNAKE_UPPER_CASEは、エンティティ名やプロパティ名をスネークケース（アンダースコア区切り）の大文字に変換します。この例の場合、テーブル名はEMPLOYEE_INFOになります。

naming要素に何も指定しない場合、デフォルトでは、テーブル名にはエンティティクラスの単純名、カラム名にはプロパティ名が使用されます。

ネーミング規約は、@Tableや@Columのname要素が指定されない場合のみ使用されます。 @Tableや@Columのname要素が指定された場合は、name要素に指定した値が使用され、ネーミング規約は適用されません。

NamingTypeには次の列挙定数があります。

テーブル

エンティティに対応するテーブル情報を指定するには、 @Table を使用します。

name要素でテーブル名を指定できます。

@Entity
@Table(name = "EMP")
public class Employee {
    ...
}

catalog要素や schema要素 でカタログやスキーマを指定できます。

@Entity
@Table(catalog = "CATALOG", schema ="SCHEMA", name = "EMP")
public class Employee {
    ...
}

@Tableを使用しない、もしくは @Tableのname要素を使用しない場合、 テーブル名は、ネーミング規約により解決されます。

継承

任意のクラスを継承できます。

ただし、親クラスのフィールドが永続フィールドとみなされたりDomaのアノテーションが解釈されたりするのは、親クラスが@Entityで注釈されている場合だけです。

永続的なフィールド

永続的なフィールドは、テーブルや結果セットのカラムに対応します。

フィールドの型は、基本型もしくはドメインクラスでなければいけません。

@Entity
public class Employee {
    ...
    Integer employeeId;
}

非永続的なフィールド

非永続的なフィールドは、テーブルや結果セットのカラムに対応しません。

@Transientを注釈して示します。 フィールドの型や可視性に制限はありません。

@Transient
BigDecimal tempSalary;

@Transient
List<String> nameList;

取得時の状態を管理するフィールド

取得時の状態とは、エンティティがDaoから取得されときの全プロパティの値です。 取得時の状態を保持しておくことで、Daoインタフェースの@Updateが注釈されたメソッドを介して更新処理を実行する際、 UPDATE文のSET句に変更したフィールドのみを含めるようにすることが可能です。 取得時の状態を管理するフィールドは、テーブルや結果セットのカラムに対応しません。

@OriginalStatesを注釈して示します。 フィールドの型はフィールドが属するエンティティクラスと同じ型でなければいけません。 @OriginalStatesが注釈されたフィールドはアプリケーションで初期化したりアクセスしたりしてはいけません。

@OriginalStates
Employee originalStates;

@OriginalStatesが注釈されたフィールドを持つエンティティの利用法は次のとおりです。

@Entity
public class Employee {

   @Id
   Integer id;

   String name;

   Integer age;

   @OriginalStates
   Employee originalStates;

   ...
}

EmployeeDao dao = new EmployeeDaoImpl();
Employee employee =dao.selectById(1);
emoloyee.setAge(employee.getAge() + 1);
dao.update(employee);

この例では、UPDATE文のSET句にAGEカラムだけが含まれます。