FieldResult


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   * Is used to map the columns specified in the SELECT list 
31   * of the query to the properties or fields of the entity class.
32   *
33   * <pre>
34   *
35   * Example:
36   *   Query q = em.createNativeQuery(
37   *       "SELECT o.id AS order_id, " +
38   *           "o.quantity AS order_quantity, " +
39   *           "o.item AS order_item, " +
40   *         "FROM Order o, Item i " +
41   *         "WHERE (order_quantity > 25) AND (order_item = i.id)",
42   *       "OrderResults");
43   *
44   *   &#064;SqlResultSetMapping(name="OrderResults",
45   *       entities={
46   *           &#064;EntityResult(entityClass=com.acme.Order.class, fields={
47   *               &#064;FieldResult(name="id", column="order_id"),
48   *               &#064;FieldResult(name="quantity", column="order_quantity"),
49   *               &#064;FieldResult(name="item", column="order_item")})
50   *       })
51   * </pre>
52   *
53   * @since Java Persistence 1.0
54   */
55  @Target  ({}) 
56  @Retention  (RUNTIME)
57  
58  public @interface FieldResult { 
59  
60      /** Name of the persistent field or property of the class. */
61      String   name();
62  
63      /** 
64       * Name of the column in the SELECT clause - i.e., column 
65       * aliases, if applicable. 
66       */
67      String   column();
68  }
69
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags