EntityGraph (javax.persistence-api 2.2 API)

型パラメータ:

T - ルートエンティティの型
```
public interface EntityGraph<T>
```
この型はエンティティグラフとエンティティのリレーションシップの境界と属性ノードを定義するためのテンプレートとして使用されるエンティティグラフのルートを表します。ルートはエンティティ型でなければなりません。
サブグラフを追加するメソッドは暗黙的に対応する属性ノードも作成します。そのような属性ノードは重複して指定するべきではありません。

導入されたバージョン:

Java Persistence 2.1

関連項目:

AttributeNode, Subgraph, NamedEntityGraph

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAttributeNodes(Attribute<T,?>... attribute)` エンティティグラフに一つ以上の属性ノードを追加します。
`void`	`addAttributeNodes(java.lang.String... attributeName)` エンティティグラフに一つ以上の属性ノードを追加します。
`<X> Subgraph<X>`	`addKeySubgraph(Attribute<T,X> attribute)` 管理された型のマップキーに対応するノードをグラフに追加します。
`<X> Subgraph<? extends X>`	`addKeySubgraph(Attribute<T,X> attribute, java.lang.Class<? extends X> type)` 継承のある管理された型のマップキーに対応するノードをグラフに追加します。
`<X> Subgraph<X>`	`addKeySubgraph(java.lang.String attributeName)` 管理された型のマップキーに対応するノードをグラフに追加します。
`<X> Subgraph<X>`	`addKeySubgraph(java.lang.String attributeName, java.lang.Class<X> type)` 継承のある管理された型のマップキーに対応するノードをグラフに追加します。
`<T> Subgraph<? extends T>`	`addSubclassSubgraph(java.lang.Class<? extends T> type)` このEntityGraphのエンティティ型のサブクラスの属性に対応する追加の属性をこのエンティティグラフに追加します。
`<X> Subgraph<X>`	`addSubgraph(Attribute<T,X> attribute)` 管理された型に対応するノードをグラフに追加します。
`<X> Subgraph<? extends X>`	`addSubgraph(Attribute<T,X> attribute, java.lang.Class<? extends X> type)` 継承のある管理された型に対応するノードをグラフに追加します。
`<X> Subgraph<X>`	`addSubgraph(java.lang.String attributeName)` 管理された型に対応するノードをグラフに追加します。
`<X> Subgraph<X>`	`addSubgraph(java.lang.String attributeName, java.lang.Class<X> type)` 継承のある管理された型に対応するノードをグラフに追加します。
`java.util.List<AttributeNode<?>>`	`getAttributeNodes()` エンティティグラフに含まれるこのエンティティの属性ノードを返します。
`java.lang.String`	`getName()` 名前付きEntityGraph(`NamedEntityGraph`アノテーション、XMLディスクリプタ要素で定義された、または`addNamedEntityGraph`メソッドで追加されたエンティティグラフ)の名前を返します。

- メソッドの詳細
  - getName
```
java.lang.String getName()
```
    名前付きEntityGraph(NamedEntityGraphアノテーション、XMLディスクリプタ要素で定義された、またはaddNamedEntityGraphメソッドで追加されたエンティティグラフ)の名前を返します。 EntityGraphが名前付きEntityGraphでない場合はnullを返します。
  - addAttributeNodes
```
void addAttributeNodes(java.lang.String... attributeName)
```
    エンティティグラフに一つ以上の属性ノードを追加します。
    
    パラメータ:
    
    attributeName - 属性の名前
    
    例外:
    
    java.lang.IllegalArgumentException - 属性がこのエンティティの属性でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addAttributeNodes
```
void addAttributeNodes(Attribute<T,?>... attribute)
```
    エンティティグラフに一つ以上の属性ノードを追加します。
    
    パラメータ:
    
    attribute - 属性
    
    例外:
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addSubgraph
```
<X> Subgraph<X> addSubgraph(Attribute<T,X> attribute)
```
    管理された型に対応するノードをグラフに追加します。これにより関連する管理対象タイプを含むマルチノードのエンティティグラフの構築が可能になります。
    
    パラメータ:
    
    attribute - 属性
    
    戻り値:
    
    属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプが管理された型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addSubgraph
```
<X> Subgraph<? extends X> addSubgraph(Attribute<T,X> attribute,
                                      java.lang.Class<? extends X> type)
```
    継承のある管理された型に対応するノードをグラフに追加します。これによりエンティティグラフのこのノードに対して複数のサブクラスのサブグラフを定義することが可能になります。サブクラスのサブグラフには指定されたスーパークラスのサブグラフの属性が自動的に含まれます。
    
    パラメータ:
    
    attribute - 属性
    
    type - エンティティのサブクラス
    
    戻り値:
    
    属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプが管理された型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addSubgraph
```
<X> Subgraph<X> addSubgraph(java.lang.String attributeName)
```
    管理された型に対応するノードをグラフに追加します。これにより関連する管理対象タイプを含むマルチノードのエンティティグラフの構築が可能になります。
    
    パラメータ:
    
    attributeName - 属性の名前
    
    戻り値:
    
    属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性がこのエンティティの属性でない場合
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプが管理された型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addSubgraph
```
<X> Subgraph<X> addSubgraph(java.lang.String attributeName,
                            java.lang.Class<X> type)
```
    継承のある管理された型に対応するノードをグラフに追加します。これによりエンティティグラフのこのノードに対して複数のサブクラスのサブグラフを定義することが可能になります。サブクラスのサブグラフには指定されたスーパークラスのサブグラフの属性が自動的に含まれます。
    
    パラメータ:
    
    attributeName - 属性の名前
    
    type - エンティティのサブクラス
    
    戻り値:
    
    属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性がこの管理された型の属性でない場合
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプが管理された型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addKeySubgraph
```
<X> Subgraph<X> addKeySubgraph(Attribute<T,X> attribute)
```
    管理された型のマップキーに対応するノードをグラフに追加します。これにより関連する管理対象タイプを含むマルチノードのエンティティグラフの構築が可能になります。
    
    パラメータ:
    
    attribute - 属性
    
    戻り値:
    
    キー属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプがエンティティでない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addKeySubgraph
```
<X> Subgraph<? extends X> addKeySubgraph(Attribute<T,X> attribute,
                                         java.lang.Class<? extends X> type)
```
    継承のある管理された型のマップキーに対応するノードをグラフに追加します。これによりエンティティグラフのこのノードに対して複数のサブクラスのサブグラフを定義することが可能になります。サブクラスのサブグラフには指定されたスーパークラスのサブグラフの属性が自動的に含まれます。
    
    パラメータ:
    
    attribute - 属性
    
    type - エンティティのサブクラス
    
    戻り値:
    
    キー属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプがエンティティでない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addKeySubgraph
```
<X> Subgraph<X> addKeySubgraph(java.lang.String attributeName)
```
    管理された型のマップキーに対応するノードをグラフに追加します。これにより関連する管理対象タイプを含むマルチノードのエンティティグラフの構築が可能になります。
    
    パラメータ:
    
    attributeName - 属性の名前
    
    戻り値:
    
    キー属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性がこのエンティティの属性でない場合
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプがエンティティでない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addKeySubgraph
```
<X> Subgraph<X> addKeySubgraph(java.lang.String attributeName,
                               java.lang.Class<X> type)
```
    継承のある管理された型のマップキーに対応するノードをグラフに追加します。これによりエンティティグラフのこのノードに対して複数のサブクラスのサブグラフを定義することが可能になります。サブクラスのサブグラフには指定されたスーパークラスのサブグラフの属性が自動的に含まれます。
    
    パラメータ:
    
    attributeName - 属性の名前
    
    type - エンティティのサブクラス
    
    戻り値:
    
    キー属性のためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - 属性がこのエンティティの属性でない場合
    
    java.lang.IllegalArgumentException - 属性のターゲットタイプが管理された型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - addSubclassSubgraph
```
<T> Subgraph<? extends T> addSubclassSubgraph(java.lang.Class<? extends T> type)
```
    このEntityGraphのエンティティ型のサブクラスの属性に対応する追加の属性をこのエンティティグラフに追加します。サブクラスのサブグラフには指定されたスーパークラスのサブグラフの属性が自動的に含まれます。
    
    パラメータ:
    
    type - エンティティのサブクラス
    
    戻り値:
    
    サブクラスのためのサブグラフ
    
    例外:
    
    java.lang.IllegalArgumentException - typeがエンティティ型でない場合
    
    java.lang.IllegalStateException - EntityGraphが静的に定義されている場合
  - getAttributeNodes
```
java.util.List<AttributeNode<?>> getAttributeNodes()
```
    エンティティグラフに含まれるこのエンティティの属性ノードを返します。
    
    戻り値:
    
    アノテーションの付いたエンティティ型のための属性ノード、何も定義されてない場合は空のList

インタフェース EntityGraph<T>

メソッドのサマリー

メソッドの詳細

getName

addAttributeNodes

addAttributeNodes

addSubgraph

addSubgraph

addSubgraph

addSubgraph

addKeySubgraph

addKeySubgraph

addKeySubgraph

addKeySubgraph

addSubclassSubgraph

getAttributeNodes