Package org.eclipse.persistence.annotations

Annotation Type CollectionTable

  • @Target({METHOD,FIELD})
@Retention(RUNTIME)
public @interface CollectionTable
    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.
    Since:
    Oracle TopLink 11.1.1.0.0
    Author:
    Guy Pelletier
    See Also:
    BasicMap, BasicCollection, CollectionTable

    • Optional Element Summary

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

    • Element Detail

      • name

        java.lang.String name
        Deprecated.
        (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

        java.lang.String catalog
        Deprecated.
        (Optional) The catalog of the table. It defaults to the persistence unit default catalog.
        Default:
        ""

      • schema

        java.lang.String schema
        Deprecated.
        (Optional) The schema of the table. It defaults to the persistence unit default schema.
        Default:
        ""

      • primaryKeyJoinColumns

        javax.persistence.PrimaryKeyJoinColumn[] primaryKeyJoinColumns
        Deprecated.
        (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

        javax.persistence.UniqueConstraint[] uniqueConstraints
        Deprecated.
        (Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect.
        Default:
        {}