OrderColumn (javax.persistence-api 2.2 API)

```
@Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface OrderColumn
```
リストの永続化された順序を維持するために使用されるカラム(順序カラム)を指定します。永続化プロバイダは検索時とデータベース内での順序の維持を担当します。永続化プロバイダはリストに影響を与える挿入、削除、並べ替えを反映するために、データベースへのフラッシュ時に順序の更新を担当します。
OrderColumnアノテーションは、OneToManyやManyToManyのリレーションシップや要素コレクションで指定されます。 OrderColumnアノテーションはリレーションシップのうち順序付けされるコレクションを参照する側で指定されます。順序カラムはエンティティや組み込みクラスの一部の状態としては参照できません。
OrderByアノテーションは永続化状態の一部として参照でき、アプリケーションによって維持される順序として使用される必要があります。 OrderByアノテーションはOrderColumnが指定されている場合は使用しません。
順序カラムは整数型でなければいけません。永続化プロバイダは関連付けや要素コレクションを更新するときに順序カラムの値を連続した(疎ではない)順序を維持します。最初の要素の順序カラムの値は0です。
```
    Example:

    @Entity
    public class CreditCard {

       @Id long ccNumber;

       @OneToMany  // unidirectional
       @OrderColumn
       List<CardTransaction> transactionHistory;
       ...
    }

 
```
導入されたバージョン:

Java Persistence 2.0

関連項目:

OrderBy

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`java.lang.String`	`columnDefinition` (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。
`boolean`	`insertable` (オプション) 永続化プロバイダによって生成されたSQL INSERTステートメントにカラムが含まれるかどうか。
`java.lang.String`	`name` (オプション) 順序カラムの名前。
`boolean`	`nullable` (オプション) データベースのカラムがNULLを許容するかどうか。
`boolean`	`updatable` (オプション) 永続化プロバイダによって生成されたSQL UPDATEステートメントにカラムが含まれるかどうか。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    (オプション) 順序カラムの名前。デフォルトでは参照もとのプロパティまたはフィールドの名前、"_"、"ORDER"が連結されます。
    
    デフォルト:
    
    ""
- - nullable
```
public abstract boolean nullable
```
    (オプション) データベースのカラムがNULLを許容するかどうか。
    
    デフォルト:
    
    true
- - insertable
```
public abstract boolean insertable
```
    (オプション) 永続化プロバイダによって生成されたSQL INSERTステートメントにカラムが含まれるかどうか。
    
    デフォルト:
    
    true
- - updatable
```
public abstract boolean updatable
```
    (オプション) 永続化プロバイダによって生成されたSQL UPDATEステートメントにカラムが含まれるかどうか。
    
    デフォルト:
    
    true
- - columnDefinition
```
public abstract java.lang.String columnDefinition
```
    (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。デフォルトでは型推論されたカラムを作成するSQLを生成します。
    
    デフォルト:
    
    ""

注釈型 OrderColumn

任意要素のサマリー

要素の詳細

name

nullable

insertable

updatable

columnDefinition