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.RetentionPolicy.RUNTIME;
41:
42: /**
43: * References an entity in the SELECT clause of a SQL query.
44: * If this annotation is used, the SQL statement should select
45: * all of the columns that are mapped to the entity object.
46: * This should include foreign key columns to related entities.
47: * The results obtained when insufficient data is available
48: * are undefined.
49: *
50: * <pre>
51: * Example
52: * Query q = em.createNativeQuery(
53: * "SELECT o.id, o.quantity, o.item, i.id, i.name, i.description "+
54: * "FROM Order o, Item i " +
55: * "WHERE (o.quantity > 25) AND (o.item = i.id)",
56: * "OrderItemResults");
57: * @SqlResultSetMapping(name="OrderItemResults",
58: * entities={
59: * @EntityResult(entityClass=com.acme.Order.class),
60: * @EntityResult(entityClass=com.acme.Item.class)
61: * })
62: * </pre>
63: *
64: * @since Java Persistence 1.0
65: */
66: @Target({})
67: @Retention(RUNTIME)
68: public @interface EntityResult {
69:
70: /** The class of the result */
71: Class entityClass();
72:
73: /**
74: * Maps the columns specified in the SELECT list of the
75: * query to the properties or fields of the entity class.
76: */
77: FieldResult[] fields() default {};
78:
79: /**
80: * Specifies the column name (or alias) of the column in
81: * the SELECT list that is used to determine the type of
82: * the entity instance.
83: */
84: String discriminatorColumn() default "";
85: }
|