EntityManagerFactory (javax.persistence-api 2.2 API)

```
public interface EntityManagerFactory
```
永続化ユニットのためのエンティティマネージャファクトリーと対話するために使用されるインターフェースです。
アプリケーションがエンティティマネージャファクトリーの使用を終了したとき、および/もしくはアプリケーションのシャットダウン時に、アプリケーションはエンティティマネージャファクトリーをクローズする必要があります。いったんEntityManagerFactoryがクローズされると関連するエンティティマネージャーはすべてクローズ状態だとみなされます。

導入されたバージョン:

Java Persistence 1.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`<T> void`	`addNamedEntityGraph(java.lang.String graphName, EntityGraph<T> entityGraph)` EntityManagerFactoryにエンティティグラフの名前の付いたコピーを追加します。
`void`	`addNamedQuery(java.lang.String name, Query query)` `createNamedQuery`や`createNamedStoredProcedureQuery`メソッドを使用してクエリーオブジェクトを作成できるように、 QueryもしくはTypedQuery、StoredProcedureQueryのクエリーを名前付きクエリーとして定義します。
`void`	`close()` ファクトリーをクローズし、確保していたすべてのリソースを解放します。
`EntityManager`	`createEntityManager()` 新しいアプリケーション管理の`EntityManager`を作成します。
`EntityManager`	`createEntityManager(java.util.Map map)` 指定されたプロパティのMapで新しいアプリケーション管理の`EntityManager`を作成します。
`EntityManager`	`createEntityManager(SynchronizationType synchronizationType)` 指定されたSynchronizationTypeで新しいアプリケーション管理の`EntityManager`を作成します。
`EntityManager`	`createEntityManager(SynchronizationType synchronizationType, java.util.Map map)` 指定されたSynchronizationTypeとプロパティのMapで新しいアプリケーション管理の`EntityManager`を作成します。
`Cache`	`getCache()` エンティティマネージャーファクトリーに関連したキャッシュにアクセスします(L2キャッシュ)。
`CriteriaBuilder`	`getCriteriaBuilder()` `CriteriaQuery`オブジェクトを作るための`CriteriaBuilder`のインスタンスを返します。
`Metamodel`	`getMetamodel()` 永続化ユニットのメタモデルにアクセスするための`Metamodel`インターフェースのインスタンスを返します。
`PersistenceUnitUtil`	`getPersistenceUnitUtil()` 永続化ユニットのためのユーティリティーメソッドへのアクセスを提供するインターフェースを返します。
`java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` エンティティマネージャーファクトリーに影響のあるプロパティと関連した値を取得します。
`boolean`	`isOpen()` ファクトリーがオープンしているかどうかを示します。
`<T> T`	`unwrap(java.lang.Class<T> cls)` プロバイダ固有のAPIへのアクセスを許可するために指定された型のオブジェクトを返します。

- メソッドの詳細
  - createEntityManager
```
EntityManager createEntityManager()
```
    新しいアプリケーション管理のEntityManagerを作成します。このメソッドは呼び出すたびに新しいEntityManagerインスタンスを返します。返されたインスタンスではisOpenメソッドはtrueを返すでしょう。
    
    戻り値:
    
    エンティティマネージャーのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
  - createEntityManager
```
EntityManager createEntityManager(java.util.Map map)
```
    指定されたプロパティのMapで新しいアプリケーション管理のEntityManagerを作成します。このメソッドは呼び出すたびに新しいEntityManagerインスタンスを返します。返されたインスタンスではisOpenメソッドはtrueを返すでしょう。
    
    パラメータ:
    
    map - エンティティマネージャーのためのプロパティ
    
    戻り値:
    
    エンティティマネージャーのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
  - createEntityManager
```
EntityManager createEntityManager(SynchronizationType synchronizationType)
```
    指定されたSynchronizationTypeで新しいアプリケーション管理のEntityManagerを作成します。このメソッドは呼び出すたびに新しいEntityManagerインスタンスを返します。返されたインスタンスではisOpenメソッドはtrueを返すでしょう。
    
    パラメータ:
    
    synchronizationType - エンティティマネージャーが何時どのように現在のJTAトランザクションと同期をとる必要があるか
    
    戻り値:
    
    エンティティマネージャーのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがリソースローカルなエンティティマネージャーとして構成されている場合か、すでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.1
  - createEntityManager
```
EntityManager createEntityManager(SynchronizationType synchronizationType,
                                  java.util.Map map)
```
    指定されたSynchronizationTypeとプロパティのMapで新しいアプリケーション管理のEntityManagerを作成します。このメソッドは呼び出すたびに新しいEntityManagerインスタンスを返します。返されたインスタンスではisOpenメソッドはtrueを返すでしょう。
    
    パラメータ:
    
    synchronizationType - エンティティマネージャーが何時どのように現在のJTAトランザクションと同期をとる必要があるか
    
    map - エンティティマネージャーのためのプロパティ
    
    戻り値:
    
    エンティティマネージャーのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがリソースローカルなエンティティマネージャーとして構成されている場合か、すでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.1
  - getCriteriaBuilder
```
CriteriaBuilder getCriteriaBuilder()
```
    CriteriaQueryオブジェクトを作るためのCriteriaBuilderのインスタンスを返します。
    
    戻り値:
    
    CriteriaBuilderのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getMetamodel
```
Metamodel getMetamodel()
```
    永続化ユニットのメタモデルにアクセスするためのMetamodelインターフェースのインスタンスを返します。
    
    戻り値:
    
    Metamodelのインスタンス
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - isOpen
```
boolean isOpen()
```
    ファクトリーがオープンしているかどうかを示します。ファクトリーがクローズされるまではtrueを返します。
    
    戻り値:
    
    ファクトリーがオープンしているかどうかを示すboolean
  - close
```
void close()
```
    ファクトリーをクローズし、確保していたすべてのリソースを解放します。ファクトリーインスタンスがクローズされると、isOpenを除いたすべてのメソッドはIllegalStateExceptionを投げるようになり、 isOpenはfalseを返すようになります。いったんEntityManagerFactoryがクローズされると関連するエンティティマネージャーはすべてクローズ状態だとみなされます。
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
  - getProperties
```
java.util.Map<java.lang.String,java.lang.Object> getProperties()
```
    エンティティマネージャーファクトリーに影響のあるプロパティと関連した値を取得します。戻り値のMapの中身に対する変更は設定に影響を与えません。
    
    戻り値:
    
    プロパティ
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getCache
```
Cache getCache()
```
    エンティティマネージャーファクトリーに関連したキャッシュにアクセスします(L2キャッシュ)。
    
    戻り値:
    
    Cacheインターフェースのインスタンス、キャッシュが使用されていない場合はnull
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getPersistenceUnitUtil
```
PersistenceUnitUtil getPersistenceUnitUtil()
```
    永続化ユニットのためのユーティリティーメソッドへのアクセスを提供するインターフェースを返します。
    
    戻り値:
    
    PersistenceUnitUtilインターフェース
    
    例外:
    
    java.lang.IllegalStateException - このエンティティマネージャーファクトリーがすでにクローズされている場合
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - addNamedQuery
```
void addNamedQuery(java.lang.String name,
                   Query query)
```
    createNamedQueryやcreateNamedStoredProcedureQueryメソッドを使用してクエリーオブジェクトを作成できるように、 QueryもしくはTypedQuery、StoredProcedureQueryのクエリーを名前付きクエリーとして定義します。
    名前付きクエリーが追加されたときに有効なクエリーオブジェクトの設定(実際のパラメーターのバインドを除く)は名前付きクエリーの定義の一部として保持されます。これには最大結果数やヒント、フラッシュモード、ロックモード、結果セットのマッピング情報、ストアドプロシージャーのパラメーターに関する情報などの構成情報が含まれます。
    クエリーが実行される時に、設定できる情報をクエリーAPIによって上書きすることができます。上書きされた情報はエンティティマネージャファクトリーに登録されている名前付きクエリーには影響しないので、その後にcreateNamedQueryやcreateNamedStoredProcedureQueryメソッドを使用して作成されたクエリーオブジェクトに影響しません。同じ名前の名前付きクエリーがメタデータまたはこのメソッドを介してすでに静的に定義されていた場合、そのクエリー定義は置き換えられます。
    
    パラメータ:
    
    name - クエリーのための名前
    
    query - QueryもしくはTypedQuery、StoredProcedureQueryのオブジェクト
    
    導入されたバージョン:
    
    Java Persistence 2.1
  - unwrap
```
<T> T unwrap(java.lang.Class<T> cls)
```
    プロバイダ固有のAPIへのアクセスを許可するために指定された型のオブジェクトを返します。プロバイダのEntityManagerFactoryの実装が指定されたクラスをサポートしていない場合はPersistenceExceptionが投げられます。
    
    パラメータ:
    
    cls - 返されるオブジェクトのクラス、これは通常はEntityManagerFactoryの基となる実装クラスか、その実装のインターフェース
    
    戻り値:
    
    指定されたクラスのインスタンス
    
    例外:
    
    PersistenceException - プロバイダがこの呼び出しをサポートしていない場合
    
    導入されたバージョン:
    
    Java Persistence 2.1
  - addNamedEntityGraph
```
<T> void addNamedEntityGraph(java.lang.String graphName,
                             EntityGraph<T> entityGraph)
```
    EntityManagerFactoryにエンティティグラフの名前の付いたコピーを追加します。すでに同じ名前のエンティティグラフが存在する場合、置き換えられます。
    
    パラメータ:
    
    graphName - エンティティグラフの名前
    
    entityGraph - エンティティグラフ
    
    導入されたバージョン:
    
    Java Persistence 2.1

インタフェース EntityManagerFactory

メソッドのサマリー

メソッドの詳細

createEntityManager

createEntityManager

createEntityManager

createEntityManager

getCriteriaBuilder

getMetamodel

isOpen

close

getProperties

getCache

getPersistenceUnitUtil

addNamedQuery

unwrap

addNamedEntityGraph