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 may be specified on a one-to-many or many-to-many relationship or on an element collection. The OrderColumn annota- tion 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.

Since:

JPA 2.0 version.

Author:

Florent Benoit

See Also:

JPA 2.0 specification

Optional Element Summary

String	columnDefinition (Optional) The SQL fragment that is used when generating the DDL for the column.
boolean	insertable (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
String	name (Optional) The name of the ordering col- umn.
boolean	nullable (Optional) Whether the database column is nullable.
boolean	updatable (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

name

public abstract String name

(Optional) The name of the ordering col- umn.

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 String columnDefinition

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

Default:

""