パッケージ jakarta.persistence

アノテーションインターフェース OrderBy


@TargetSE({METHODSE,FIELDSE}) @RetentionSE(RUNTIMESE) public @interface OrderBy
関連またはコレクションが取得される時点での、コレクション値の関連または要素コレクションの要素の順序を指定します。

value 順序付け要素の構文は、次のように orderby_list です。

ASC または DESC が指定されていない場合、ASC (昇順)が想定されます。

エンティティの関連付けに順序付け要素が指定されていない場合、関連付けられたエンティティの主キーによる順序付けが想定されます。

プロパティまたはフィールド名は、関連するクラスまたはその中の埋め込みクラスの永続的なプロパティまたはフィールドの名前に対応している必要があります。順序付けで使用されるプロパティまたはフィールドは、比較演算子がサポートされている列に対応している必要があります。

ドット (.) 表記は、埋め込み属性内の属性を参照するために使用されます。ドット表記で使用される各識別子の値は、それぞれの埋め込みフィールドまたはプロパティの名前です。

OrderBy アノテーションは要素コレクションに適用できます。OrderBy が基本型の要素コレクションに適用される場合、順序付けは基本オブジェクトの値によって行われ、プロパティまたはフィールド名は使用されません。埋め込み型の要素コレクションに対して順序付けを指定する場合、順序付けを決定する属性を指定するためにドット表記を使用する必要があります。

OrderBy アノテーションは、OrderColumn を使用して順序列が指定されている場合には使用されません。

例 1:

例 2:

例 3:

導入:
1.0
関連事項:
  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    orderby_list
  • 要素の詳細

    • value

      StringSE value
      orderby_list。次のように指定されます。

      ASC または DESC が指定されていない場合、ASC (昇順)が想定されます。

      ordering 要素が指定されていない場合、関連付けられたエンティティの主キーによる順序付けが想定されます。

      デフォルト:
      ""