EntityResult


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  package javax.persistence;
24  
25  import java.lang.annotation.Target  ;
26  import java.lang.annotation.Retention  ;
27  import static java.lang.annotation.RetentionPolicy.RUNTIME  ;
28  
29  /**
30   * References an entity in the SELECT clause of a SQL query.
31   * If this annotation is used, the SQL statement should select 
32   * all of the columns that are mapped to the entity object. 
33   * This should include foreign key columns to related entities. 
34   * The results obtained when insufficient data is available 
35   * are undefined.
36   *
37   * <pre>
38   *   Example
39   *   Query q = em.createNativeQuery(
40   *       "SELECT o.id, o.quantity, o.item, i.id, i.name, i.description "+
41   *           "FROM Order o, Item i " +
42   *           "WHERE (o.quantity > 25) AND (o.item = i.id)",
43   *       "OrderItemResults");
44   *   &#064;SqlResultSetMapping(name="OrderItemResults",
45   *       entities={
46   *           &#064;EntityResult(entityClass=com.acme.Order.class),
47   *           &#064;EntityResult(entityClass=com.acme.Item.class)
48   *   })
49   * </pre>
50   *
51   * @since Java Persistence 1.0
52   */
53  @Target  ({}) 
54  @Retention  (RUNTIME)
55  
56  public @interface EntityResult { 
57  
58      /** The class of the result */
59      Class   entityClass(); 
60  
61      /** 
62       * Maps the columns specified in the SELECT list of the 
63       * query to the properties or fields of the entity class. 
64       */
65      FieldResult[] fields() default {};
66  
67      /** 
68       * Specifies the column name (or alias) of the column in 
69       * the SELECT list that is used to determine the type of 
70       * the entity instance.
71       */
72      String   discriminatorColumn() default "";
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags