mirror of https://github.com/apache/cloudstack.git
87 lines
3.4 KiB
Java
87 lines
3.4 KiB
Java
/*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|
*
|
|
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
|
|
*
|
|
* The contents of this file are subject to the terms of either the GNU
|
|
* General Public License Version 2 only ("GPL") or the Common Development
|
|
* and Distribution License("CDDL") (collectively, the "License"). You
|
|
* may not use this file except in compliance with the License. You can obtain
|
|
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
|
|
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
|
|
* language governing permissions and limitations under the License.
|
|
*
|
|
* When distributing the software, include this License Header Notice in each
|
|
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
|
|
* Sun designates this particular file as subject to the "Classpath" exception
|
|
* as provided by Sun in the GPL Version 2 section of the License file that
|
|
* accompanied this code. If applicable, add the following below the License
|
|
* Header, with the fields enclosed by brackets [] replaced by your own
|
|
* identifying information: "Portions Copyrighted [year]
|
|
* [name of copyright owner]"
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* If you wish your version of this file to be governed by only the CDDL or
|
|
* only the GPL Version 2, indicate your decision by adding "[Contributor]
|
|
* elects to include this software in this distribution under the [CDDL or GPL
|
|
* Version 2] license." If you don't indicate a single choice of license, a
|
|
* recipient has the option to distribute your version of this file under
|
|
* either the CDDL, the GPL Version 2 or to extend the choice of license to
|
|
* its licensees as provided above. However, if you add GPL Version 2 code
|
|
* and therefore, elected the GPL Version 2 license, then the option applies
|
|
* only if the new code is made subject to such option by the copyright
|
|
* holder.
|
|
*/
|
|
package javax.persistence;
|
|
|
|
import java.lang.annotation.Target;
|
|
import java.lang.annotation.Retention;
|
|
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
|
|
|
/**
|
|
* References an entity in the SELECT clause of a SQL query.
|
|
* If this annotation is used, the SQL statement should select
|
|
* all of the columns that are mapped to the entity object.
|
|
* This should include foreign key columns to related entities.
|
|
* The results obtained when insufficient data is available
|
|
* are undefined.
|
|
*
|
|
* <pre>
|
|
* Example
|
|
* Query q = em.createNativeQuery(
|
|
* "SELECT o.id, o.quantity, o.item, i.id, i.name, i.description "+
|
|
* "FROM Order o, Item i " +
|
|
* "WHERE (o.quantity > 25) AND (o.item = i.id)",
|
|
* "OrderItemResults");
|
|
* @SqlResultSetMapping(name="OrderItemResults",
|
|
* entities={
|
|
* @EntityResult(entityClass=com.acme.Order.class),
|
|
* @EntityResult(entityClass=com.acme.Item.class)
|
|
* })
|
|
* </pre>
|
|
*
|
|
* @since Java Persistence 1.0
|
|
*/
|
|
@Target({})
|
|
@Retention(RUNTIME)
|
|
|
|
public @interface EntityResult {
|
|
|
|
/** The class of the result */
|
|
Class entityClass();
|
|
|
|
/**
|
|
* Maps the columns specified in the SELECT list of the
|
|
* query to the properties or fields of the entity class.
|
|
*/
|
|
FieldResult[] fields() default {};
|
|
|
|
/**
|
|
* Specifies the column name (or alias) of the column in
|
|
* the SELECT list that is used to determine the type of
|
|
* the entity instance.
|
|
*/
|
|
String discriminatorColumn() default "";
|
|
}
|