01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence;
37:
38: import java.lang.annotation.Target;
39: import java.lang.annotation.Retention;
40: import static java.lang.annotation.ElementType.TYPE;
41: import static java.lang.annotation.RetentionPolicy.RUNTIME;
42:
43: /**
44: * This annotation is used to specify the mapping of the result
45: * of a native SQL query.
46: *
47: * <pre>
48: * Example:
49: *
50: * Query q = em.createNativeQuery(
51: * "SELECT o.id AS order_id, " +
52: * "o.quantity AS order_quantity, " +
53: * "o.item AS order_item, " +
54: * "i.name AS item_name, " +
55: * "FROM Order o, Item i " +
56: * "WHERE (order_quantity > 25) AND (order_item = i.id)",
57: * "OrderResults");
58: *
59: * @SqlResultSetMapping(name="OrderResults",
60: * entities={
61: * @EntityResult(entityClass=com.acme.Order.class, fields={
62: * @FieldResult(name="id", column="order_id"),
63: * @FieldResult(name="quantity", column="order_quantity"),
64: * @FieldResult(name="item", column="order_item")})},
65: * columns={
66: * @ColumnResult(name="item_name")}
67: * )
68: * </pre>
69: *
70: * @since Java Persistence 1.0
71: */
72: @Target({TYPE})
73: @Retention(RUNTIME)
74: public @interface SqlResultSetMapping {
75:
76: /**
77: * The name given to the result set mapping, and used to refer
78: * to it in the methods of the {@link Query} API.
79: */
80: String name();
81:
82: /** Specifies the result set mapping to entities. */
83: EntityResult[] entities() default {};
84:
85: /** Specifies the result set mapping to scalar values. */
86: ColumnResult[] columns() default {};
87: }
|