org.seasar.framework.jpa
インタフェース PersistenceUnitManager

既知の実装クラスの一覧:

PersistenceUnitManagerImpl

public interface PersistenceUnitManager

永続ユニットを管理するコンポーネントのインターフェースです。

作成者:

koichik

フィールドの概要

static String

DEFAULT_PERSISTENCE_UNIT_NAME デフォルトの永続ユニット名

メソッドの概要

String	getAbstractPersistenceUnitName(Class<?> entityClass) 指定のエンティティクラスを扱う抽象永続ユニット名を返します。
String	getAbstractPersistenceUnitName(String mappingFile) 指定のマッピングファイルを扱う抽象永続ユニット名を返します。
String	getConcretePersistenceUnitName(Class<?> entityClass) 指定のエンティティクラスを扱う具象永続ユニット名を返します。
String	getConcretePersistenceUnitName(String mappingFile) 指定のマッピングファイルを扱う具象永続ユニット名を返します。
EntityManagerFactory	getEntityManagerFactory(String unitName) 指定されたユニット名を持つEntityManagerFactoryを返します。
EntityManagerFactory	getEntityManagerFactory(String unitName, PersistenceUnitProvider provider) 指定されたユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactoryを返します。
EntityManagerFactory	getEntityManagerFactory(String abstractUnitName, String concreteUnitName) 指定された具象ユニット名を持つEntityManagerFactoryを返します。
EntityManagerFactory	getEntityManagerFactory(String abstractUnitName, String concreteUnitName, PersistenceUnitProvider provider) 指定された具象ユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactoryを返します。
PersistenceUnitContext	getPersistenceUnitContext(EntityManagerFactory emf) 指定のEntityManagerFactoryに関連づけられた永続ユニットコンテキストを返します。
PersistenceUnitProvider	getPersistenceUnitProvider(Class<?> entityClass) 指定のエンティティクラスを扱うPersistenceUnitProviderのコンポーネントを返します。
PersistenceUnitProvider	getPersistenceUnitProvider(String unitName) 具象名で指定された永続ユニットを提供するPersistenceUnitProviderのコンポーネントを返します。

フィールドの詳細

DEFAULT_PERSISTENCE_UNIT_NAME

static final String DEFAULT_PERSISTENCE_UNIT_NAME

デフォルトの永続ユニット名

関連項目:

定数フィールド値

メソッドの詳細

getEntityManagerFactory

EntityManagerFactory getEntityManagerFactory(String unitName)

指定されたユニット名を持つEntityManagerFactoryを返します。

パラメータ:

unitName - ユニット名

戻り値:

指定されたユニット名を持つEntityManagerFactory

getEntityManagerFactory

EntityManagerFactory getEntityManagerFactory(String unitName,
                                             PersistenceUnitProvider provider)

指定されたユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactoryを返します。

パラメータ:

unitName - ユニット名

provider - EntityManagerFactoryを作成する{PersistenceUnitProvider}

戻り値:

指定されたユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactory

getEntityManagerFactory

EntityManagerFactory getEntityManagerFactory(String abstractUnitName,
                                             String concreteUnitName)

指定された具象ユニット名を持つEntityManagerFactoryを返します。

パラメータ:

abstractUnitName - 抽象ユニット名

concreteUnitName - 具象ユニット名

戻り値:

指定されたユニット名を持つEntityManagerFactory

getEntityManagerFactory

EntityManagerFactory getEntityManagerFactory(String abstractUnitName,
                                             String concreteUnitName,
                                             PersistenceUnitProvider provider)

指定された具象ユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactoryを返します。

パラメータ:

abstractUnitName - 抽象ユニット名

concreteUnitName - 具象ユニット名

provider - EntityManagerFactoryを作成する{PersistenceUnitProvider}

戻り値:

指定されたユニット名を持ち、指定の{PersistenceUnitProvider}から作成されたEntityManagerFactory

getPersistenceUnitContext

PersistenceUnitContext getPersistenceUnitContext(EntityManagerFactory emf)

指定のEntityManagerFactoryに関連づけられた永続ユニットコンテキストを返します。

パラメータ:

emf - EntityManagerFactory

戻り値:

指定のEntityManagerFactoryに関連づけられた永続ユニットコンテキスト

getAbstractPersistenceUnitName

String getAbstractPersistenceUnitName(Class<?> entityClass)

指定のエンティティクラスを扱う抽象永続ユニット名を返します。

SMART deployモードの場合

1. エンティティクラスがNamingConventionに設定されているエンティティパッケージ直下のクラスの場合は デフォルトの永続ユニット名。
2. エンティティパッケージのサブパッケージ下のクラスの場合は、サブパッケージ名をプレフィックスとしてデフォルトの永続ユニットに付加した名称。

SMART deployモードでない場合

常にデフォルトの永続ユニット名。

パラメータ:

entityClass - エンティティクラス

戻り値:

指定のエンティティクラスを扱う抽象永続ユニット名

getAbstractPersistenceUnitName

String getAbstractPersistenceUnitName(String mappingFile)

指定のマッピングファイルを扱う抽象永続ユニット名を返します。

SMART deployモードの場合

1. マッピングファイルがNamingConventionに設定されているエンティティパッケージ直下のファイルの場合は、デフォルトの永続ユニット名。
2. エンティティパッケージのサブパッケージ下のファイルの場合は、サブパッケージ名をプレフィックスとしてデフォルトの永続ユニットに付加した名称。

SMART deployモードでない場合

常にデフォルトの永続ユニット名。

パラメータ:

mappingFile - マッピングファイル

戻り値:

指定のマッピングファイルを扱う抽象永続ユニット名

getConcretePersistenceUnitName

String getConcretePersistenceUnitName(Class<?> entityClass)

指定のエンティティクラスを扱う具象永続ユニット名を返します。

SMART deployモードの場合

1. エンティティクラスがNamingConventionに設定されているエンティティパッケージ直下のクラスの場合
   1. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていれば、 そのプレフィックスをデフォルトの永続ユニット名に付加した名称。
   2. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていなければ、 デフォルトの永続ユニット名。
2. エンティティパッケージのサブパッケージ下のクラスの場合は、サブパッケージ名をプレフィックスとしてデフォルトの永続ユニットに付加した名称。

SMART deployモードでない場合

常にデフォルトの永続ユニット名。

パラメータ:

entityClass - エンティティクラス

戻り値:

指定のエンティティクラスを扱う具象永続ユニット名

getConcretePersistenceUnitName

String getConcretePersistenceUnitName(String mappingFile)

指定のマッピングファイルを扱う具象永続ユニット名を返します。

SMART deployモードの場合

1. マッピングファイルがNamingConventionに設定されているエンティティパッケージ直下のファイルの場合
   1. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていれば、 そのプレフィックスをデフォルトの永続ユニット名に付加した名称。
   2. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていなければ、 デフォルトの永続ユニット名。
2. エンティティパッケージのサブパッケージ下のファイルの場合は、サブパッケージ名をプレフィックスとしてデフォルトの永続ユニットに付加した名称。

SMART deployモードでない場合

常にデフォルトの永続ユニット名。

パラメータ:

mappingFile - マッピングファイル

戻り値:

指定のマッピングファイルを扱う具象永続ユニット名

getPersistenceUnitProvider

PersistenceUnitProvider getPersistenceUnitProvider(Class<?> entityClass)

指定のエンティティクラスを扱うPersistenceUnitProviderのコンポーネントを返します。

SMART deployモードの場合

1. エンティティクラスがNamingConventionに設定されているエンティティパッケージ直下のクラスの場合
   1. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていれば、 そのプレフィックスをデフォルトの永続ユニット名に付加した名称を持つ永続プロバイダ。
   2. DataSourceFactory.setSelectableDataSourceName(String)にプレフィックスが設定されていなければ、 デフォルトの永続ユニット名を持つ永続プロバイダ。
2. エンティティパッケージのサブパッケージ下のクラスの場合は、サブパッケージ名をプレフィックスとしてデフォルトの永続ユニットに付加した名称を持つ永続プロバイダ。

SMART deployモードでない場合

常にデフォルトの永続ユニット名を持つ永続プロバイダ。

パラメータ:

entityClass - エンティティクラス

戻り値:

指定のエンティティクラスを扱うPersistenceUnitProviderのコンポーネント

getPersistenceUnitProvider

PersistenceUnitProvider getPersistenceUnitProvider(String unitName)

具象名で指定された永続ユニットを提供するPersistenceUnitProviderのコンポーネントを返します。

パラメータ:

unitName - 永続ユニットの具象名

戻り値:

具象名で指定された永続ユニットを提供するPersistenceUnitProviderのコンポーネント