javax.persistence
Annotation Type CollectionTable


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

The CollectionTable annotation is used in the mapping of collections of basic or embeddable types. The CollectionTable annotation specifies the table that is used for the mapping of the collection and is specified on the collection-valued field or property.

Since:
JPA 2.0 version.
Author:
Florent Benoit
See Also:
JPA 2.0 specification

Optional Element Summary
 String catalog
          (Optional) The catalog of the table.
 JoinColumn[] joinColumns
          (Optional) The foreign key col- umns of the collection table which reference the primary table of the entity.
 String name
          (Optional) The name of the collec- tion table.
 String schema
          (Optional) The schema of the table.
 UniqueConstraint[] uniqueConstraints
          (Optional) Unique constraints that are to be placed on the table.
 

name

public abstract String name
(Optional) The name of the collec- tion table.

Default:
""

catalog

public abstract String catalog
(Optional) The catalog of the table.

Default:
""

schema

public abstract String schema
(Optional) The schema of the table.

Default:
""

joinColumns

public abstract JoinColumn[] joinColumns
(Optional) The foreign key col- umns of the collection table which reference the primary table of the 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:
{}


Copyright © 2007-2012 OW2 Consortium. All Rights Reserved.