javax.persistence

インタフェース PersistenceUnitUtil

すべてのスーパーインタフェース:

PersistenceUtil

public interface PersistenceUnitUtil
extends PersistenceUtil

アプリケーションと永続化プロバイダが管理する永続化ユニットの間のユーティリティインターフェースです。

このインタフェースのメソッドは、この永続化ユニットのためのエンティティマネージャーから得られたエンティティもしくは新しいエンティティのインタスタンスにのみ呼び出す必要があります。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	getIdentifier(java.lang.Object entity) エンティティのIDを返します。
boolean	isLoaded(java.lang.Object entity) 永続化ユニットに属するエンティティのロード状態を測定します。
boolean	isLoaded(java.lang.Object entity, java.lang.String attributeName) 永続化ユニットに属するエンティティの属性のロード状態を測定します。

メソッドの詳細

isLoaded

boolean isLoaded(java.lang.Object entity,
                 java.lang.String attributeName)

永続化ユニットに属するエンティティの属性のロード状態を測定します。

定義:

isLoaded インタフェース内 PersistenceUtil

パラメータ:

entity - 属性が含まれるエンティティ

attributeName - ロード状態を測定される属性の名前

戻り値:

エンティティがロードされてない状態の場合や属性がロードされてない状態の場合はfalse、そうでない場合はtrue

isLoaded

boolean isLoaded(java.lang.Object entity)

永続化ユニットに属するエンティティのロード状態を測定します。 このメソッドはリファレンスが渡されるエンティティのロード状態を測定するために使用できます。 FetchType.EAGERが指定されているすべての属性がロードされているときにエンティティはロードされているとみなされます。

属性のロード状態を測定するためにはisLoaded(Object, String)メソッドを使用する必要があります。 そうしない場合、意図しない状態のロードにつながる可能性があります。

定義:

isLoaded インタフェース内 PersistenceUtil

パラメータ:

entity - ロード状態を測定されるエンティティ

戻り値:

エンティティがロードされていない場合はfalse、そうでない場合はtrue

getIdentifier

java.lang.Object getIdentifier(java.lang.Object entity)

エンティティのIDを返します。 生成されたIDはデータベースへの挿入が発生するまで利用可能であるとは限りません。 エンティティにまだIDが降られてない場合はnullが返ります。

パラメータ:

entity - エンティティインスタンス

戻り値:

エンティティのID

例外:

java.lang.IllegalArgumentException - オブジェクトがエンティティではない場合