パッケージ jakarta.persistence

インターフェース Graph<T>

すべての既知のサブインターフェース:
EntityGraph<T>Subgraph<T>

public interface Graph<T>
EntityGraphSubgraph に共通の操作を宣言します。
導入:
3.2
関連事項:
  • メソッドの詳細

    • addAttributeNode

      <Y> AttributeNode<Y> addAttributeNode(StringSE attributeName)
      指定された名前の属性の既存の属性ノードを取得するか、既存のノードがない場合は新しい属性ノードを追加します。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      属性ノード
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      IllegalStateExceptionSE - EntityGraph が静的に定義されている場合
      導入:
      3.2
    • addAttributeNode

      <Y> AttributeNode<Y> addAttributeNode(Attribute<? super T,Y> attribute)
      指定された属性の既存の属性ノードを取得するか、既存のノードがない場合は新しい属性ノードを追加します。
      パラメーター:
      attribute - 属性
      戻り値:
      属性ノード
      例外:
      IllegalStateExceptionSE - EntityGraph が静的に定義されている場合
      導入:
      3.2
    • hasAttributeNode

      boolean hasAttributeNode(StringSE attributeName)
      指定された名前の属性に既存の属性ノードが存在するかどうかを確認します。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      既存の属性ノードがある場合は true
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      導入:
      3.2
    • hasAttributeNode

      boolean hasAttributeNode(Attribute<? super T,?> attribute)
      指定された属性に既存の属性ノードが存在するかどうかを確認します。
      パラメーター:
      attribute - 属性
      戻り値:
      既存の属性ノードがある場合は true
      導入:
      3.2
    • getAttributeNode

      <Y> AttributeNode<Y> getAttributeNode(StringSE attributeName)
      指定された名前の属性の既存の属性ノードを取得します。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      属性ノード
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      NoSuchElementExceptionSE - 属性の既存のノードがない場合
      導入:
      3.2
    • getAttributeNode

      <Y> AttributeNode<Y> getAttributeNode(Attribute<? super T,Y> attribute)
      指定された属性の既存の属性ノードを取得します。
      パラメーター:
      attribute - 属性
      戻り値:
      属性ノード
      例外:
      NoSuchElementExceptionSE - 属性の既存のノードがない場合
      導入:
      3.2
    • removeAttributeNode

      void removeAttributeNode(StringSE attributeName)
      エンティティグラフから属性ノードを削除します。このグラフが負荷グラフとして解釈される場合、この操作により、即時フェッチ用にマップされた属性が含まれることが抑制されます。この呼び出しの効果は、その後の addAttributeNode(java.lang.String) または addSubgraph(jakarta.persistence.metamodel.Attribute<? super T, X>) の呼び出しによってオーバーライドされる可能性があります。指定された属性名の既存のノードがない場合、この操作は効果がありません。
      パラメーター:
      attributeName - 属性の名前
      導入:
      3.2
    • removeAttributeNode

      void removeAttributeNode(Attribute<? super T,?> attribute)
      エンティティグラフから属性ノードを削除します。このグラフがロードグラフとして解釈される場合、この操作は、即時フェッチ用にマップされた属性の組み込みを抑制します。この呼び出しの効果は、addAttributeNode(java.lang.String) または addSubgraph(jakarta.persistence.metamodel.Attribute<? super T, X>) の後続の呼び出しによって上書きされる可能性があります。指定された属性の既存のノードがない場合、この操作は効果がありません。
      パラメーター:
      attribute - 属性
      導入:
      3.2
    • removeAttributeNodes

      void removeAttributeNodes(Attribute.PersistentAttributeType nodeTypes)
      指定された属性型のすべての属性ノードを削除します。このグラフがロードグラフとして解釈される場合、この操作は、即時フェッチ用にマップされた属性の組み込みを抑制します。この呼び出しの効果は、addAttributeNode(java.lang.String) または addSubgraph(jakarta.persistence.metamodel.Attribute<? super T, X>) の後続の呼び出しによって上書きされる可能性があります。
      導入:
      3.2
    • addAttributeNodes

      void addAttributeNodes(StringSE... attributeName)
      エンティティグラフに 1 つ以上の属性ノードを追加します。指定された属性名のいずれかにすでにノードが存在する場合、その特定の引数は無視され、効果はありません。
      パラメーター:
      attributeName - 属性の名前
      例外:
      IllegalArgumentExceptionSE - 属性がこの管理対象型の属性でない場合。
      IllegalStateExceptionSE - EntityGraph が静的に定義されている場合
    • addAttributeNodes

      void addAttributeNodes(Attribute<? super T,?>... attribute)
      エンティティグラフに 1 つ以上の属性ノードを追加します。指定された属性のいずれかにすでにノードが存在する場合、その特定の引数は無視され、効果はありません。
      パラメーター:
      attribute - 属性
      例外:
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addSubgraph

      <X> Subgraph<X> addSubgraph(Attribute<? super T,X> attribute)
      管理対象型に対応するノードをグラフに追加します。これにより、関連するマネージ型を含むマルチノードエンティティグラフを作成できます。
      パラメーター:
      attribute - 属性
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - EntityGraph が静的に定義されている場合
    • addTreatedSubgraph

      <Y> Subgraph<Y> addTreatedSubgraph(Attribute<? super T,? super Y> attribute, ClassSE<Y> type)
      継承のある管理型に対応するノードをグラフに追加します。これにより、エンティティグラフのこのノードに複数のサブクラスサブグラフを定義できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます。
      パラメーター:
      attribute - 属性
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - EntityGraph が静的に定義されている場合
      導入:
      3.2
    • addSubgraph

      @DeprecatedSE(since="3.2", forRemoval=true) <X> Subgraph<? extends X> addSubgraph(Attribute<? super T,X> attribute, ClassSE<? extends X> type)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      継承されたマネージ型に対応するノードをグラフに追加します。これにより、エンティティグラフのこのノードに複数のサブクラスサブグラフを定義できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
      パラメーター:
      attribute - 属性
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addSubgraph

      <X> Subgraph<X> addSubgraph(StringSE attributeName)
      管理対象型に対応するノードをグラフに追加します。これにより、関連するマネージ型を含むマルチノードエンティティグラフを作成できます。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこの管理対象型の属性でない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addSubgraph

      <X> Subgraph<X> addSubgraph(StringSE attributeName, ClassSE<X> type)
      継承されたマネージ型に対応するノードをグラフに追加します。これにより、エンティティグラフのこのノードに複数のサブクラスサブグラフを定義できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
      パラメーター:
      attributeName - 属性の名前
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこの管理対象型の属性でない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addElementSubgraph

      <E> Subgraph<E> addElementSubgraph(PluralAttribute<? super T,?,E> attribute)
      管理型であるコレクション要素に対応するノードをグラフに追加します。これにより、関連する管理型を含む複数ノードのエンティティグラフを構築できます。
      パラメーター:
      attribute - 属性
      戻り値:
      要素属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がエンティティでない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
      導入:
      3.2
    • addTreatedElementSubgraph

      <E> Subgraph<E> addTreatedElementSubgraph(PluralAttribute<? super T,?,? super E> attribute, ClassSE<E> type)
      管理型であるコレクション要素に対応するノードをグラフに追加します。これにより、関連する管理型を含む複数ノードのエンティティグラフを構築できます。
      パラメーター:
      attribute - 属性
      戻り値:
      要素属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がエンティティでない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
      導入:
      3.2
    • addElementSubgraph

      <X> Subgraph<X> addElementSubgraph(StringSE attributeName)
      管理型であるコレクション要素に対応するノードをグラフに追加します。これにより、関連する管理型を含む複数ノードのエンティティグラフを構築できます。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      要素属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addElementSubgraph

      <X> Subgraph<X> addElementSubgraph(StringSE attributeName, ClassSE<X> type)
      管理型であるコレクション要素に対応するノードをグラフに追加します。これにより、関連する管理型を含む複数ノードのエンティティグラフを構築できます。
      パラメーター:
      attributeName - 属性の名前
      type - エンティティサブクラス
      戻り値:
      要素属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addMapKeySubgraph

      <K> Subgraph<K> addMapKeySubgraph(MapAttribute<? super T,K,?> attribute)
      管理対象型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。
      パラメーター:
      attribute - 属性
      戻り値:
      キー属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型エンティティではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addTreatedMapKeySubgraph

      <K> Subgraph<K> addTreatedMapKeySubgraph(MapAttribute<? super T,? super K,?> attribute, ClassSE<K> type)
      継承のあるマネージド型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
      パラメーター:
      attribute - 属性
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型エンティティではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addKeySubgraph

      @DeprecatedSE(since="3.2", forRemoval=true) <X> Subgraph<X> addKeySubgraph(Attribute<? super T,X> attribute)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理対象型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。
      パラメーター:
      attribute - 属性
      戻り値:
      キー属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型エンティティではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addKeySubgraph

      @DeprecatedSE(since="3.2", forRemoval=true) <X> Subgraph<? extends X> addKeySubgraph(Attribute<? super T,X> attribute, ClassSE<? extends X> type)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      継承のあるマネージド型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
      パラメーター:
      attribute - 属性
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型エンティティではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addKeySubgraph

      <X> Subgraph<X> addKeySubgraph(StringSE attributeName)
      管理対象型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。
      パラメーター:
      attributeName - 属性の名前
      戻り値:
      キー属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • addKeySubgraph

      <X> Subgraph<X> addKeySubgraph(StringSE attributeName, ClassSE<X> type)
      継承のあるマネージド型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が含まれます
      パラメーター:
      attributeName - 属性の名前
      type - エンティティサブクラス
      戻り値:
      属性のサブグラフ
      例外:
      IllegalArgumentExceptionSE - 属性がこのエンティティの属性ではない場合。
      IllegalArgumentExceptionSE - 属性のターゲット型がマネージ型ではない場合
      IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合
    • getAttributeNodes

      ListSE<AttributeNode<?>> getAttributeNodes()
      グラフに含まれるこのマネージド型の属性に対応する属性ノードを返します。
      戻り値:
      グラフに含まれる属性ノードのリスト、または何も定義されていない場合は空のリスト