javax.persistence.SqlResultSetMapping Maven / Gradle / Ivy
// $Id: SqlResultSetMapping.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Specifies the mapping of the result of a native SQL query.
*
*
* Example:
*
* Query q = em.createNativeQuery(
* "SELECT o.id AS order_id, " +
* "o.quantity AS order_quantity, " +
* "o.item AS order_item, " +
* "i.name AS item_name, " +
* "FROM Order o, Item i " +
* "WHERE (order_quantity > 25) AND (order_item = i.id)",
* "OrderResults");
*
* @SqlResultSetMapping(name="OrderResults",
* entities={
* @EntityResult(entityClass=com.acme.Order.class, fields={
* @FieldResult(name="id", column="order_id"),
* @FieldResult(name="quantity", column="order_quantity"),
* @FieldResult(name="item", column="order_item")})},
* columns={
* @ColumnResult(name="item_name")}
* )
*
*
* @since Java Persistence 1.0
*/
@Target({ TYPE })
@Retention(RUNTIME)
public @interface SqlResultSetMapping {
/**
* The name given to the result set mapping, and used to refer
* to it in the methods of the {@link Query} API.
*/
String name();
/**
* Specifies the result set mapping to entities.
*/
EntityResult[] entities() default { };
/**
* Specifies the result set mapping to scalar values.
*/
ColumnResult[] columns() default { };
}