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 to define that the object is embedded into the table of the 
26   * owning object.
27   * Corresponds to the xml element "embedded".
28   * 
29   * @version 2.1
30   * @since 2.1
31   */
32  @Target({ElementType.FIELD, ElementType.METHOD}) 
33  @Retention(RetentionPolicy.RUNTIME)
34  public @interface Embedded
35  {
36      /** The member in the embedded object that links back to the owning object
37       * where it has a bidirectional relationship. 
38       * @return the member that refers to the owner
39       */
40      String ownerMember() default "";
41  
42      /** The column in the embedded object used to judge if the embedded object
43       * is null. 
44       * @return the null indicator column
45       */
46      String nullIndicatorColumn() default "";
47  
48      /** The value in the null column to interpret the object as being null.
49       * @return the null indicator value
50       */
51      String nullIndicatorValue() default "";
52  
53      /** Members for this embedding. 
54       * @return the members embedded in the field or property being annotated
55       */
56      Persistent[] members() default {};
57  }