net.java.ao.EntityManagerのメソッド - いろいろ解析日記

EntityManagerオブジェクトには、エンティティの取得や作成のメソッドが含まれています。
ActiveObjectを使う場合、頻繁にこのクラスのメソッドを利用することになると思います。
そこで、今回はEntityManagerのメソッドについて以下のようにまとめてみました。

SELECT

find

指定した型のエンティティを選択する。

選択対象	戻り値	引数
すべてのエンティティ	,K> T[]	Classtype
指定したクエリに一致するすべてのエンティティ	,K> T[]	Classtype, Query query
指定したクライテリアとパラメータに一致するすべてのエンティティ	,K> T[]	Classtype, String criteria, Object...parameters
指定したクエリに一致するすべてのエンティティ。また、エンティティ作成に使用するフィールドを明示的に指定する。	,K> T[]	Classtype, String field, Query query

findWithSQL

指定したSQLを実行し、指定したキーフィールドを抽出し、各行を指定した型にラッピングする。

戻り値	引数
,K> T[]	Classtype, StringkeyField, Stringsql, Object...parameters

count

指定した型のエンティティの数を数える。

カウント対象	戻り値	引数
すべてのエンティティ	int	Class<？ extends RawEntity>type
指定したクエリに一致するすべてのエンティティ	int	Class<？ extends RawEntity>type, Query query
指定したクライテリアとパラメータに一致するすべてのエンティティ	int	Class<？ extends RawEntity>type, String criteria, Object...parameters

INSERT

create

エンティティを作成し、INSERTを行います。オプションで初期パラメータを指定できる。

初期パラメータ指定方法	戻り値	引数
任意の個数のDBパラメータ	,K> T	Classtype, DBParam...params
フィールドと値のマップ	,K> T	Classtype, Mapparams

DELETE

delete

指定したエンティティをDELETEする。

戻り値	引数
void	RawEntity<？>...entities

エンティティ取得

get

指定した型のエンティティを取得する。エンティティは主キーの値により特定する。

主キーキー・エンティティの個数	戻り値	引数
複数	,K> T[]	Classtype, K...keys
単一	,K> T	Classtype, K key

getAndInstantiate

指定した型のエンティティのインスタンスを生成する。エンティティは主キーの値により特定する。

戻り値	引数
protected ,K> T	Classtype, Kkey

キャッシュ

flush

指定したエンティティの値キャッシュと関連キャッシュをフラッシュする。

戻り値	引数
void	RawEntity<？>...entities

flushAll

すべての値キャッシュと関連キャッシュをフラッシュする。

戻り値	void

getCache

値キャッシュを取得する。

戻り値	Cache

setCache

値キャッシュを設定する。

戻り値	引数
void	Cache cache

DROP/CREATE TABLE

migrate

指定したエンティティのスキーマを作成する。テーブル/フィールド名コンバータとデータベースプロバイダはEntityManagerに設定されているものを使用する。

戻り値	引数
void	Class<？ extends RawEntity<？>>...entities

名前変換

getTableNameConverter

テーブル名コンバータを取得する。

戻り値	TableNameConverter

setTableNameConverter

テーブル名コンバータを設定する。

戻り値	引数
void	TableNameConvertertableNameConverter

getFieldNameConverter

フィールド名コンバータのインスタンスを取得する。

戻り値	FieldNameConverter

setFieldNameConverter

フィールド名コンバータを設定する。

戻り値	引数
void	FieldNameConverterfieldNameConverter

getPolymorphicTypeMapper

ポリモフィック型マッパーを取得する。

戻り値	PolymorphicTypeMapper

setPolymorphicTypeMapper

ポリモフィック型マッパーを設定する。

戻り値	引数
void	PolymorphicTypeMappertypeMapper

接続先DB

getProvider

データベースプロバイダを取得する。

戻り値	DatabaseProvider