ColumnResult


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