Top Fields Constructors Methods
org.hibernate.boot.model.internal

public Class MapKeyJoinColumnDelegator

extends Object
implements JoinColumn
Class Inheritance
All Implemented Interfaces
jakarta.persistence.JoinColumn, java.lang.annotation.Annotation
Annotations
@SuppressWarnings:ClassExplicitlyAnnotation
Imports
java.lang.annotation.Annotation, jakarta.persistence.Column, .ForeignKey, .JoinColumn, .MapKeyJoinColumn

Author
Emmanuel Bernard

Field Summary

Modifier and TypeField and Description
private final MapKeyJoinColumn

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Class<? extends Annotation>
annotationType()

Implements java.lang.annotation.Annotation.annotationType.

Returns the annotation interface of this annotation.
public String
columnDefinition()

Implements jakarta.persistence.JoinColumn.columnDefinition.

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

Implements jakarta.persistence.JoinColumn.foreignKey.

(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect.
public boolean
insertable()

Implements jakarta.persistence.JoinColumn.insertable.

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

Implements jakarta.persistence.JoinColumn.name.

(Optional) The name of the foreign key column.
public boolean
nullable()

Implements jakarta.persistence.JoinColumn.nullable.

(Optional) Whether the foreign key column is nullable.
public String
referencedColumnName()

Implements jakarta.persistence.JoinColumn.referencedColumnName.

(Optional) The name of the column referenced by this foreign key column.
public String
table()

Implements jakarta.persistence.JoinColumn.table.

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

Implements jakarta.persistence.JoinColumn.unique.

(Optional) Whether the property is a unique key.
public boolean
updatable()

Implements jakarta.persistence.JoinColumn.updatable.

(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

columnback to summary
private final MapKeyJoinColumn column

Constructor Detail

MapKeyJoinColumnDelegatorback to summary
public MapKeyJoinColumnDelegator(MapKeyJoinColumn column)

Method Detail

annotationTypeback to summary
public Class<? extends Annotation> annotationType()

Implements java.lang.annotation.Annotation.annotationType.

Doc from java.lang.annotation.Annotation.annotationType.

Returns the annotation interface of this annotation.

Returns:Class<? extends Annotation>

the annotation interface of this annotation

Annotations
@Override
columnDefinitionback to summary
public String columnDefinition()

Implements jakarta.persistence.JoinColumn.columnDefinition.

Doc from jakarta.persistence.JoinColumn.columnDefinition.

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

Defaults to the generated SQL for the column.

Annotations
@Override
foreignKeyback to summary
public ForeignKey foreignKey()

Implements jakarta.persistence.JoinColumn.foreignKey.

Doc from jakarta.persistence.JoinColumn.foreignKey.

(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If this element is not specified, the persistence provider's default foreign key strategy will apply.

Annotations
@Override
insertableback to summary
public boolean insertable()

Implements jakarta.persistence.JoinColumn.insertable.

Doc from jakarta.persistence.JoinColumn.insertable.

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

Annotations
@Override
nameback to summary
public String name()

Implements jakarta.persistence.JoinColumn.name.

Doc from jakarta.persistence.JoinColumn.name.

(Optional) The name of the foreign key column. The table in which it is found depends upon the context.

  • If the join is for a OneToOne or ManyToOne mapping using a foreign key mapping strategy, the foreign key column is in the table of the source entity or embeddable.
  • If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the foreign key is in the table of the target entity.
  • If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the foreign key is in a join table.
  • If the join is for an element collection, the foreign key is in a collection table.

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.

Annotations
@Override
nullableback to summary
public boolean nullable()

Implements jakarta.persistence.JoinColumn.nullable.

Doc from jakarta.persistence.JoinColumn.nullable.

(Optional) Whether the foreign key column is nullable.

Annotations
@Override
referencedColumnNameback to summary
public String referencedColumnName()

Implements jakarta.persistence.JoinColumn.referencedColumnName.

Doc from jakarta.persistence.JoinColumn.referencedColumnName.

(Optional) The name of the column referenced by this foreign key column.

  • When used with entity relationship mappings other than the cases described here, the referenced column is in the table of the target entity.
  • When used with a unidirectional OneToMany foreign key mapping, the referenced column is in the table of the source entity.
  • When used inside a 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.
  • When used in a 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.

Annotations
@Override
tableback to summary
public String table()

Implements jakarta.persistence.JoinColumn.table.

Doc from jakarta.persistence.JoinColumn.table.

(Optional) The name of the table that contains the column. If a table is not specified, the column is assumed to be in the primary table of the applicable entity.

Default:

  • If the join is for a OneToOne or ManyToOne mapping using a foreign key mapping strategy, the name of the table of the source entity or embeddable.
  • If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the name of the table of the target entity.
  • If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the name of the join table.
  • If the join is for an element collection, the name of the collection table.
Annotations
@Override
uniqueback to summary
public boolean unique()

Implements jakarta.persistence.JoinColumn.unique.

Doc from jakarta.persistence.JoinColumn.unique.

(Optional) Whether the property is a unique key. This is a shortcut for the 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.

Annotations
@Override
updatableback to summary
public boolean updatable()

Implements jakarta.persistence.JoinColumn.updatable.

Doc from jakarta.persistence.JoinColumn.updatable.

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

Annotations
@Override