javax.persistence

インタフェース Subgraph<T>

型パラメータ:

T - 属性の型

public interface Subgraph<T>

この型はマネージドタイプに対応する属性ノードのサブグラフを表します。 このクラスを使用する事でEntityGraph内にエンティティサブグラフを埋め込むことができます。

導入されたバージョン:

Java Persistence 2.1

関連項目:

EntityGraph, AttributeNode, NamedSubgraph

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addAttributeNodes(Attribute<T,?>... attribute) エンティティグラフに1つ以上の属性ノードを追加します。
void	addAttributeNodes(java.lang.String... attributeName) エンティティグラフに1つ以上の属性ノードを追加します。
<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) 継承を持つマネージドタイプであるマップキーに対応するノードをグラフに追加します。
<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() subgraphに含まれるこのマネージドタイプの属性に対応する属性ノードを返します。
java.lang.Class<T>	getClassType() このsubgraphが定義された型を返します。

メソッドの詳細

addAttributeNodes

void addAttributeNodes(java.lang.String... attributeName)

エンティティグラフに1つ以上の属性ノードを追加します。

パラメータ:

attributeName - 属性の名前

例外:

java.lang.IllegalArgumentException - この属性がこのマネージドタイプの属性でない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addAttributeNodes

void addAttributeNodes(Attribute<T,?>... attribute)

エンティティグラフに1つ以上の属性ノードを追加します。

パラメータ:

attribute - 属性

例外:

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addSubgraph

<X> Subgraph<X> addSubgraph(Attribute<T,X> attribute)

マネージドタイプに対応するノードをグラフに追加します。 これにより関連するマネージドタイプを含むマルチノードのエンティティグラフの構築が可能になります。

パラメータ:

attribute - 属性

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addSubgraph

<X> Subgraph<? extends X> addSubgraph(Attribute<T,X> attribute,
                                      java.lang.Class<? extends X> type)

継承のあるマネージドタイプに対応するノードをグラフに追加します。 これによりエンティティグラフのこのノードに対して複数のサブクラスのsubgraphを定義することを可能になります。 サブクラスのsubgraphには指定されたスーパークラスのsubgraphの属性が自動的に含まれます。

パラメータ:

attribute - 属性

type - エンティティのサブクラス

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addSubgraph

<X> Subgraph<X> addSubgraph(java.lang.String attributeName)

マネージドタイプに対応するノードをグラフに追加します。 これにより関連するマネージドタイプを含むマルチノードのエンティティグラフの構築が可能になります。

パラメータ:

attributeName - 属性の名前

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性がこのマネージドタイプの属性でない場合

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addSubgraph

<X> Subgraph<X> addSubgraph(java.lang.String attributeName,
                            java.lang.Class<X> type)

継承のあるマネージドタイプに対応するノードをグラフに追加します。 これによりエンティティグラフのこのノードに対して複数のサブクラスのsubgraphを定義することを可能になります。 サブクラスのsubgraphには指定されたスーパークラスのsubgraphの属性が自動的に含まれます。

パラメータ:

attributeName - 属性の名前

type - エンティティのサブクラス

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性がこのマネージドタイプの属性でない場合

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addKeySubgraph

<X> Subgraph<X> addKeySubgraph(Attribute<T,X> attribute)

マネージドタイプであるマップキーに対応するノードをグラフに追加します。 これにより関連するマネージドタイプを含むマルチノードのエンティティグラフの構築が可能になります。

パラメータ:

attribute - 属性

戻り値:

キー属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプエンティティでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addKeySubgraph

<X> Subgraph<? extends X> addKeySubgraph(Attribute<T,X> attribute,
                                         java.lang.Class<? extends X> type)

継承を持つマネージドタイプであるマップキーに対応するノードをグラフに追加します。 これによりエンティティグラフのこのノードに対して複数のサブクラスのsubgraphを定義することを可能になります。 サブクラスのsubgraphには指定されたスーパークラスのsubgraphの属性が自動的に含まれます。

パラメータ:

attribute - 属性

type - エンティティのサブクラス

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプエンティティでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addKeySubgraph

<X> Subgraph<X> addKeySubgraph(java.lang.String attributeName)

マネージドタイプであるマップキーに対応するノードをグラフに追加します。 これにより関連するマネージドタイプを含むマルチノードのエンティティグラフの構築が可能になります。

パラメータ:

attributeName - 属性の名前

戻り値:

キー属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - この属性がこのエンティティの属性でない場合

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

addKeySubgraph

<X> Subgraph<X> addKeySubgraph(java.lang.String attributeName,
                               java.lang.Class<X> type)

継承を持つマネージドタイプであるマップキーに対応するノードをグラフに追加します。 これによりエンティティグラフのこのノードに対して複数のサブクラスのsubgraphを定義することを可能になります。 サブクラスのsubgraphには指定されたスーパークラスのsubgraphの属性が自動的に含まれます。

パラメータ:

attributeName - 属性の名前

type - エンティティのサブクラス

戻り値:

属性のためのsubgraph

例外:

java.lang.IllegalArgumentException - 属性がこのエンティティの属性でない場合

java.lang.IllegalArgumentException - この属性のターゲットタイプがマネージドタイプでない場合

java.lang.IllegalStateException - EntityGraphが静的に定義されている場合

getAttributeNodes

java.util.List<AttributeNode<?>> getAttributeNodes()

subgraphに含まれるこのマネージドタイプの属性に対応する属性ノードを返します。

戻り値:

subgraphに含まれる属性ノードのリスト、定義されていない場合は空のリスト

getClassType

java.lang.Class<T> getClassType()

このsubgraphが定義された型を返します。

戻り値:

subgraphによって参照されるマネージドタイプ