@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface JoinColumn
JoinColumn
annotation itself is
defaulted, a single join column is assumed and the default values
apply.
Example: @ManyToOne @JoinColumn(name="ADDR_ID") public Address getAddress() { return address; } Example: unidirectional one-to-many association using a foreign key mapping // In Customer class @OneToMany @JoinColumn(name="CUST_ID") // join column is in table for Order public Set<Order> getOrders() {return orders;}
ManyToOne
,
OneToMany
,
OneToOne
,
JoinTable
,
CollectionTable
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
columnDefinition
(Optional) The SQL fragment that is used when
generating the DDL for the column.
|
ForeignKey |
foreignKey
(Optional) The foreign key constraint specification for the join column.
|
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 foreign key column.
|
boolean |
nullable
(Optional) Whether the foreign key column is nullable.
|
java.lang.String |
referencedColumnName
(Optional) The name of the column referenced by this foreign
key column.
|
java.lang.String |
table
(Optional) The name of the table that contains
the column.
|
boolean |
unique
(Optional) Whether the property is a unique key.
|
boolean |
updatable
(Optional) Whether the column is included in
SQL UPDATE statements generated by the persistence
provider.
|
public abstract java.lang.String name
Default (only applies if a single join column is used): The concatenation of the following: the name of the referencing relationship property or field of the referencing entity or embeddable class; "_"; the name of the referenced primary key column. If there is no such referencing relationship property or field in the entity, or if the join is for an element collection, the join column name is formed as the concatenation of the following: the name of the entity; "_"; the name of the referenced primary key column.
public abstract java.lang.String referencedColumnName
JoinTable
annotation,
the referenced key column is in the entity table of the owning
entity, or inverse entity if the join is part of the inverse
join definition.
CollectionTable
mapping, the
referenced column is in the table of the entity containing the
collection.
Default (only applies if single join column is being used): The same name as the primary key column of the referenced table.
public abstract boolean unique
UniqueConstraint
annotation at
the table level and is useful for when the unique key
constraint is only a single field. It is not necessary to
explicitly specify this for a join column that corresponds to a
primary key that is part of a foreign key.public abstract boolean nullable
public abstract boolean insertable
public abstract boolean updatable
public abstract java.lang.String columnDefinition
Defaults to the generated SQL for the column.
public abstract java.lang.String table
Default:
public abstract ForeignKey foreignKey