KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > persistence > NamedNativeQuery


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 JavaDoc;
26 import java.lang.annotation.Retention JavaDoc;
27 import static java.lang.annotation.ElementType.TYPE JavaDoc;
28 import static java.lang.annotation.RetentionPolicy.RUNTIME JavaDoc;
29
30 /**
31  * Is used to specify a native SQL named query.
32  * Query names are scoped to the persistence unit.
33  *
34  * @since Java Persistence 1.0
35  */

36 @Target JavaDoc({TYPE})
37 @Retention JavaDoc(RUNTIME)
38 public @interface NamedNativeQuery {
39
40     /**
41      * Is used to refer to the query when using the {@link EntityManager}
42      * methods that create query objects.
43      */

44     String JavaDoc name();
45
46     /** The SQL query string */
47     String JavaDoc query();
48
49     /** Vendor-specific query hints */
50     QueryHint[] hints() default {};
51
52     /** The class of the result */
53     Class JavaDoc resultClass() default void.class;
54
55     /** The name of a {@link SqlResultSetMapping}, as defined in metadata */
56     String JavaDoc resultSetMapping() default "";
57 }
58
Popular Tags