javax.persistence.spi

インタフェース PersistenceProvider

public interface PersistenceProvider

永続化プロバイダによって実装されるインタフェースです。

これは、Java EE環境のコンテナと、Java SE環境のPersistenceクラスによって呼び出され、 EntityManagerFactoryを作成したり、スキーマの生成を行います。

導入されたバージョン:

Java Persistence 1.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
EntityManagerFactory	createContainerEntityManagerFactory(PersistenceUnitInfo info, java.util.Map map) EntityManagerFactoryを作成するときにコンテナによって呼び出されます。
EntityManagerFactory	createEntityManagerFactory(java.lang.String emName, java.util.Map map) EntityManagerFactoryを作成するときにPersistenceクラスによって呼び出されます。
void	generateSchema(PersistenceUnitInfo info, java.util.Map map) データベーススキーマやテーブルを作成し、提供されたプロパティによって決定されるDDLスクリプトを作成します。
boolean	generateSchema(java.lang.String persistenceUnitName, java.util.Map map) データベーススキーマやテーブルを作成し、提供されたプロパティによって決定されるDDLスクリプトを作成します。
ProviderUtil	getProviderUtil() 永続化プロバイダによって実装されたユーティリティインタフェースを返します。

メソッドの詳細

createEntityManagerFactory

EntityManagerFactory createEntityManagerFactory(java.lang.String emName,
                                                java.util.Map map)

EntityManagerFactoryを作成するときにPersistenceクラスによって呼び出されます。

パラメータ:

emName - 永続化ユニットの名前

map - 永続化プロバイダによって使用されるプロパティのマップ。このプロパティを使用してpersistence.xmlファイル内の対応する要素の値を上書きしたり、 persistence.xmlで指定されていないプロパティの値を指定することができます。(プロパティを指定しない場合はnullにできます。)

戻り値:

永続化ユニットのためのEntityManagerFactory、プロバイダが適切なプロバイダでない場合はnull

createContainerEntityManagerFactory

EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info,
                                                         java.util.Map map)

EntityManagerFactoryを作成するときにコンテナによって呼び出されます。

パラメータ:

info - 永続化プロバイダによって使用されるメタデータ

map - 永続化プロバイダが使用するインテグレーションレベルのプロパティのマップです。(プロパティを指定しない場合はnullにできます。) これらのプロパティにはスキーマの生成を制御するプロパティが含まれる場合があります。 Bean Validationプロバイダがクラスパスに存在する場合、コンテナはキーを"javax.persistence.validation.factory"としてマップに含めて ValidatorFactoryのインスタンスを渡す必要があります。 格納されているアーカイブがBeanアーカイブの場合、コンテナはBeanManagerインスタンスをキーを"javax.persistence.bean.manager"としてマップに含めて渡す必要があります。

戻り値:

メタデータによって指定された永続化ユニットのためのEntityManagerFactory

generateSchema

void generateSchema(PersistenceUnitInfo info,
                    java.util.Map map)

データベーススキーマやテーブルを作成し、提供されたプロパティによって決定されるDDLスクリプトを作成します。

スキーマ生成がエンティティマネージャーファクトリーの作成とは別のフェーズとして実行されるときにコンテナによって呼び出されます。

パラメータ:

info - 永続化プロバイダによって使用されるメタデータ

map - スキーマ生成のためのプロパティ、これらにはプロバイダ固有のプロパティも含まれる。

例外:

PersistenceException - 構成情報が不十分または不正確な場合、またはスキーマ生成が失敗した場合

導入されたバージョン:

Java Persistence 2.1

generateSchema

boolean generateSchema(java.lang.String persistenceUnitName,
                       java.util.Map map)

データベーススキーマやテーブルを作成し、提供されたプロパティによって決定されるDDLスクリプトを作成します。

スキーマ生成がエンティティマネージャーファクトリーの作成とは別のフェーズとして実行されるときにPersistenceクラスによって呼び出されます。

パラメータ:

persistenceUnitName - 永続化ユニットの名前

map - スキーマ生成のためのプロパティ、これらにはプロバイダ固有のプロパティも含まれる。このプロパティの値は他の場所で設定されている値を上書きします。

戻り値:

スキーマが生成された場合はtrue、そうでない場合はfalse

例外:

PersistenceException - 構成情報が不十分または不正確な場合、またはスキーマ生成が失敗した場合

導入されたバージョン:

Java Persistence 2.1

getProviderUtil

ProviderUtil getProviderUtil()

永続化プロバイダによって実装されたユーティリティインタフェースを返します。

戻り値:

ProviderUtilインターフェース

導入されたバージョン:

Java Persistence 2.0