Top Description Methods
org.eclipse.persistence.annotations

public @Interface CollectionTable

extends Annotation
Annotations
@Target:METHOD, FIELD
@Retention:RUNTIME
@Deprecated
Imports
java.lang.annotation.Retention, .Target, jakarta.persistence.PrimaryKeyJoinColumn, .UniqueConstraint

Deprecated

A CollectionTable annotation is used in conjunction with a BasicCollection or a BasicMap annotation. However, if a CollectionTable is not defined, one will be defaulted.
Author
Guy Pelletier
Since
Oracle TopLink 11.1.1.0.0
See Also
org.eclipse.persistence.annotations.BasicMap, org.eclipse.persistence.annotations.BasicCollection, jakarta.persistence.CollectionTable

Method Summary

Modifier and TypeMethod and Description
public String
catalog()

(Optional) The catalog of the table.

public String
name()

(Optional) The name of the collection table.

public PrimaryKeyJoinColumn[]
primaryKeyJoinColumns()

(Optional) Used to specify a primary key column that is used as a foreign key to join to another table.

public String
schema()

(Optional) The schema of the table.

public UniqueConstraint[]
uniqueConstraints()

(Optional) Unique constraints that are to be placed on the table.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

catalogback to summary
public String catalog()

(Optional) The catalog of the table. It defaults to the persistence unit default catalog.

nameback to summary
public String name()

(Optional) The name of the collection table. If it is not specified, it is defaulted to the concatenation of the following: the name of the source entity; "_" ; the name of the relationship property or field of the source entity.

primaryKeyJoinColumnsback to summary
public PrimaryKeyJoinColumn[] primaryKeyJoinColumns()

(Optional) Used to specify a primary key column that is used as a foreign key to join to another table. If the source entity uses a composite primary key, a primary key join column must be specified for each field of the composite primary key. In a single primary key case, a primary key join column may optionally be specified. Defaulting will apply otherwise as follows: name, the same name as the primary key column of the primary table of the source entity. referencedColumnName, the same name of primary key column of the primary table of the source entity.

schemaback to summary
public String schema()

(Optional) The schema of the table. It defaults to the persistence unit default schema.

uniqueConstraintsback to summary
public UniqueConstraint[] uniqueConstraints()

(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect.