Note: This ORM/SQL annotation is silently ignored by ObjectDB

298 words

javax.persistence.SqlResultSetMapping - JPA annotation

javax.persistence
Annotation SqlResultSetMapping

Target:
Classes
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:
JPA 1.0
Specifies the result set mapping to scalar values.
Specifies the result set mapping to scalar values.
Default value:
{}
Since:
JPA 1.0
Specifies the result set mapping to entities.
Specifies the result set mapping to entities.
Default value:
{}
Since:
JPA 1.0
String name
The name given to the result set mapping, and used to refer to it in the methods of the Query API.
The name given to the result set mapping, and used to refer to it in the methods of the Query API.
Since:
JPA 1.0

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.