javax.persistence
Annotation Type OrderColumn

@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface OrderColumn

The OrderColumn annotation specifies a column that is used to maintain the persistent order of a list. The persistence provider is responsible for maintaining the order upon retrieval and in the database. The persistence provider is responsible for updating the ordering upon flushing to the database to reflect any insertion, deletion, or reordering affecting the list. The OrderColumn annotation is specified on a one-to-many or many-to-many relationship or on an element collection. The OrderColumn annotation is specified on the side of the relationship that references the collection that is to be ordered. The order column is not visible as part of the state of the entity or embeddable class.[78] [78]The OrderBy annotation should be used for ordering that is visible as persistent state and maintained by the application. The OrderBy annotation is not used when OrderColumn is specified.

Since:

Java Persistence 2.0

Optional Element Summary

int	base (Optional) The ordering column value for the first element of the list.
java.lang.String	columnDefinition (Optional) The SQL fragment that is used when generating the DDL for the column.
boolean	contiguous (Optional) Whether the value of the ordering column need to be contiguous or may be sparse.
boolean	insertable (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
java.lang.String	name (Optional) The name of the ordering column.
boolean	nullable (Optional) Whether the database column is nullable.
java.lang.String	table (Optional) The name of the table that contains the column.
boolean	updatable (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

name

public abstract java.lang.String name

(Optional) The name of the ordering column.

Default:

""

nullable

public abstract boolean nullable

(Optional) Whether the database column is nullable.

Default:

true

insertable

public abstract boolean insertable

(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

Default:

true

updatable

public abstract boolean updatable

(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

Default:

true

columnDefinition

public abstract java.lang.String columnDefinition

(Optional) The SQL fragment that is used when generating the DDL for the column.

Default:

""

contiguous

public abstract boolean contiguous

(Optional) Whether the value of the ordering column need to be contiguous or may be sparse.

Default:

true

base

public abstract int base

(Optional) The ordering column value for the first element of the list.

Default:

0

table

public abstract java.lang.String table

(Optional) The name of the table that contains the column.

Default:

""