パッケージ jakarta.persistence

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

  • 型パラメーター:
    T - 属性の型。
    public interface Subgraph<T>
    この型は、管理対象型に対応する属性ノードのサブグラフを表します。このクラスを使用して、エンティティサブグラフを EntityGraph 内に埋め込むことができます。
    導入:
    2.1
    関連事項:
    EntityGraph, AttributeNode, NamedSubgraph

    • メソッドの詳細

      • addAttributeNodes

        void addAttributeNodes​(StringSE... attributeName)
        エンティティグラフに 1 つ以上の属性ノードを追加します。
        パラメーター:
        attributeName - 属性の名前
        例外:
        IllegalArgumentExceptionSE - 属性がこの管理対象型の属性でない場合。
        IllegalStateExceptionSE - EntityGraph が静的に定義されている場合

      • addAttributeNodes

        void addAttributeNodes​(Attribute<T,​?>... attribute)
        エンティティグラフに 1 つ以上の属性ノードを追加します。
        パラメーター:
        attribute - 属性
        例外:
        IllegalStateExceptionSE - この EntityGraph が静的に定義されている場合

      • addSubgraph

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

      • addSubgraph

        <X> Subgraph<? extends X> addSubgraph​(Attribute<T,​X> attribute,
                                      ClassSE<? extends X> type)
        継承されたマネージ型に対応するノードをグラフに追加します。これにより、エンティティグラフのこのノードに複数のサブクラスサブグラフを定義できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
        パラメーター:
        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 が静的に定義されている場合

      • addKeySubgraph

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

      • addKeySubgraph

        <X> Subgraph<? extends X> addKeySubgraph​(Attribute<T,​X> attribute,
                                         ClassSE<? extends X> type)
        継承のあるマネージド型であるマップキーに対応するノードをグラフに追加します。これにより、関連する管理対象型を含むマルチノードエンティティグラフを作成できます。サブクラスサブグラフには、スーパークラスサブグラフの指定された属性が自動的に含まれます
        パラメーター:
        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()
        サブグラフに含まれるこの管理対象型の属性に対応する属性ノードを返します。
        戻り値:
        サブグラフに含まれる属性ノードのリスト、または定義されていない場合は空のリスト

      • getClassType

        ClassSE<T> getClassType()
        このサブグラフが定義された型を返します。
        戻り値:
        サブグラフによって参照される管理対象型