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 the fetch plan of a persistence manager, query, or extent.
26   * Corresponds to the xml element "fetch-plan".
27   * 
28   * @version 2.1
29   * @since 2.1
30   */
31  @Target(ElementType.TYPE) 
32  @Retention(RetentionPolicy.RUNTIME)
33  public @interface FetchPlan
34  {
35      /**
36       * Name of the fetch plan.
37       * @return the name of the fetch plan
38       */
39      String name() default "";
40  
41      /**
42       * The fetch groups in this fetch plan.
43       * @return the fetch groups 
44       */
45      String[] fetchGroups() default {};
46  
47      /**
48       * The depth of references to instantiate, starting with the root object.
49       * @return the maxium fetch depth
50       */
51      int maxFetchDepth() default 1;
52  
53      /** 
54       * The number of instances of multi-valued fields retrieved by queries.
55       * @return the fetch size
56       */
57      int fetchSize() default 0;
58  }