org.eclipse.persistence.annotations
Annotation Type CollectionTable

@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface CollectionTable

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.

See Also:

BasicMap, BasicCollection

Author:

Guy Pelletier

Since:

Oracle TopLink 11.1.1.0.0

Optional Element Summary

java.lang.String	catalog (Optional) The catalog of the table.
java.lang.String	name (Optional) The name of the collection table.
PrimaryKeyJoinColumn[]	primaryKeyJoinColumns (Optional) Used to specify a primary key column that is used as a foreign key to join to another table.
java.lang.String	schema (Optional) The schema of the table.
UniqueConstraint[]	uniqueConstraints (Optional) Unique constraints that are to be placed on the table.

name

public abstract java.lang.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.

Default:

""

catalog

public abstract java.lang.String catalog

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

Default:

""

schema

public abstract java.lang.String schema

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

Default:

""

primaryKeyJoinColumns

public abstract 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.

Default:

{}

uniqueConstraints

public abstract UniqueConstraint[] uniqueConstraints

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

Default:

{}