Hibernate Core 3.6.10.Final · org.hibernate.cfg.annotations.MapKeyJoinColumnDelegator

Modifier and Type	Field and Description
private final MapKeyJoinColumn	column

Access	Constructor and Description
public	MapKeyJoinColumnDelegator(MapKeyJoinColumn column)

Method Summary

Modifier and Type	Method and Description
public Class<? extends Annotation>	annotationType() Implements java.lang.annotation.Annotation.annotationType. Returns the annotation interface of this annotation.
public String	columnDefinition() Implements javax.persistence.JoinColumn.columnDefinition. (Optional) The SQL fragment that is used when generating the DDL for the column.
public boolean	insertable() Implements javax.persistence.JoinColumn.insertable. (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
public String	name() Implements javax.persistence.JoinColumn.name. (Optional) The name of the foreign key column.
public boolean	nullable() Implements javax.persistence.JoinColumn.nullable. (Optional) Whether the foreign key column is nullable.
public String	referencedColumnName() Implements javax.persistence.JoinColumn.referencedColumnName. (Optional) The name of the column referenced by this foreign key column.
public String	table() Implements javax.persistence.JoinColumn.table. (Optional) The name of the table that contains the column.
public boolean	unique() Implements javax.persistence.JoinColumn.unique. (Optional) Whether the property is a unique key.
public boolean	updatable() Implements javax.persistence.JoinColumn.updatable. (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

column	back to summary
private final MapKeyJoinColumn column

MapKeyJoinColumnDelegator	back to summary
public MapKeyJoinColumnDelegator(MapKeyJoinColumn column)

Method Detail

annotationType	back 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

annotationType

back 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

columnDefinition	back to summary
public String columnDefinition() Implements javax.persistence.JoinColumn.columnDefinition. Doc from javax.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.

columnDefinition

back to summary

public String columnDefinition()

Implements javax.persistence.JoinColumn.columnDefinition.

Doc from javax.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.

insertable	back to summary
public boolean insertable() Implements javax.persistence.JoinColumn.insertable. Doc from javax.persistence.JoinColumn.insertable. (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

insertable

back to summary

public boolean insertable()

Implements javax.persistence.JoinColumn.insertable.

Doc from javax.persistence.JoinColumn.insertable.

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

name	back to summary
public String name() Implements javax.persistence.JoinColumn.name. Doc from javax.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.

name

back to summary

public String name()

Implements javax.persistence.JoinColumn.name.

Doc from javax.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.

nullable	back to summary
public boolean nullable() Implements javax.persistence.JoinColumn.nullable. Doc from javax.persistence.JoinColumn.nullable. (Optional) Whether the foreign key column is nullable.

nullable

back to summary

public boolean nullable()

Implements javax.persistence.JoinColumn.nullable.

Doc from javax.persistence.JoinColumn.nullable.

(Optional) Whether the foreign key column is nullable.

referencedColumnName back to summary

referencedColumnName	back to summary
public String referencedColumnName() Implements javax.persistence.JoinColumn.referencedColumnName. Doc from javax.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.

public String referencedColumnName()

Implements javax.persistence.JoinColumn.referencedColumnName.

Doc from javax.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.

table	back to summary
public String table() Implements javax.persistence.JoinColumn.table. Doc from javax.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.

table

back to summary

public String table()

Implements javax.persistence.JoinColumn.table.

Doc from javax.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.

unique back to summary

unique	back to summary
public boolean unique() Implements javax.persistence.JoinColumn.unique. Doc from javax.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.

public boolean unique()

Implements javax.persistence.JoinColumn.unique.

Doc from javax.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.

updatable	back to summary
public boolean updatable() Implements javax.persistence.JoinColumn.updatable. Doc from javax.persistence.JoinColumn.updatable. (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

updatable

back to summary

public boolean updatable()

Implements javax.persistence.JoinColumn.updatable.

Doc from javax.persistence.JoinColumn.updatable.

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

public Class MapKeyJoinColumnDelegator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail