View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package javax.jdo.annotations;
    18
    19  import java.lang.annotation.ElementType;
    20  import java.lang.annotation.Retention;
    21  import java.lang.annotation.RetentionPolicy;
    22  import java.lang.annotation.Target;
    23
    24  /**
    25   * Annotation for a database foreign-key.
    26   * Corresponds to the xml element "foreign-key".
    27   *
    28   * @version 2.1
    29   * @since 2.1
    30   */
    31  @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
    32  @Retention(RetentionPolicy.RUNTIME)
    33  public @interface ForeignKey
    34  {
    35      /** Name of the foreign key.
    36       * @return the name of the foreign key
    37       */
    38      String name() default "";
    39
    40      /** Table for the foreign key. This is needed iff annotating a type where
    41       * the foreign key is not defined on the primary table for the type.
    42       * @return the table on which the foreign key is defined
    43       */
    44      String table() default "";
    45
    46      /** Whether this foreign key is deferred
    47       * (constraint is checked only at commit).
    48       * @return whether this foreign key is deferred
    49       */
    50      String deferred() default "";
    51
    52      /** Whether this foreign key is unique.
    53       * @return whether this foreign key is unique
    54       */
    55      String unique() default "";
    56
    57      /** The delete action of this foreign key.
    58       * @return the delete action of this foreign key
    59       */
    60      ForeignKeyAction deleteAction() default ForeignKeyAction.RESTRICT;
    61
    62      /** The update action of this foreign key.
    63       * @return the update action of this foreign key
    64       */
    65      ForeignKeyAction updateAction() default ForeignKeyAction.RESTRICT;
    66
    67      /** Member (field and property) names that compose this foreign key.
    68       * @return the member names that compose this foreign key
    69       */
    70      String[] members() default {};
    71
    72      /** Columns that compose this foreign key.
    73       * @return the columns that compose this foreign key
    74       */
    75      Column[] columns() default {};
    76  }