Entityの基本

Entityとは？

Entityは、検索結果や更新データなどの「一レコード」を表現するオブジェクトです。 

ex) 検索結果としてEntityを利用する(Memberクラス)
MemberCB cb = new MemberCB();
cb.query().setMemberId_Equal(3);
Member member = memberBhv.selectEntity(cb);
String memberName = member.getMemberName();
member.get...();

ex) 更新データとしてEntityを利用する(Memberクラス)
Member member = new Member();
member.setMemberId(3);
member.setMemberName("Billy Joel");
member.set...
memberBhv.update(member);

Entityの種類

DomainEntity(ドメインエンティティ)
テーブルに対応するEntity。Generateタスクで自動生成される。
CustomizeEntity(カスタマイズエンティティ)
外だしSQLに対応するEntity。Sql2Entityタスクで自動生成される。

Entityの構成要素

基本的な構成要素

カラムを表現するプロパティ
Getter/Setter。Setter呼び出しの有無の情報が記録される(更新時に利用)
関連テーブルを表現するプロパティ
Getter/Setter。one-to-manyの場合はList型

付加価値的な構成要素

テーブル基本情報
getTableDbName()/getTablePropertyName()
DBMeta
getDBMeta()。Entityに対応するテーブルのDBMeta。
区分値支援メソッド
区分値の設定(classifyXxx)、区分値の判定(isXxx)など
主キー値有無判定メソッド
hasPrimaryKeyValue()
共通カラム自動設定の有効無効
デフォルトは有効。無効にしたいときにはdisableCommonColumnAutoSetup()。

カラム名の定義やメタ情報を利用したい場合は、DBMetaを利用して下さい。 EntityクラスからgetDBMeta()で該当のDBMetaを取得できます。

Document

Topics