Top Description Methods
jakarta.persistence

public @Interface SqlResultSetMapping

extends Annotation
Annotations
@Repeatable:SqlResultSetMappings
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Repeatable, .Target, .Retention
Specifies a mapping of the columns of a result set of a native SQL query or stored procedure.

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") }) 
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
1.0
See Also
Query, StoredProcedureQuery, NamedNativeQuery, NamedStoredProcedureQuery

Method Summary

Modifier and TypeMethod and Description
public ConstructorResult[]
classes()

Specifies the result set mapping to constructors.

public ColumnResult[]
columns()

Specifies the result set mapping to scalar values.

public EntityResult[]
entities()

Specifies the result set mapping to entities.

public String
name()

The name given to the result set mapping, and used to refer to it in the methods of the Query and StoredProcedureQuery APIs.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

classesback to summary
public ConstructorResult[] classes()

Specifies the result set mapping to constructors.

Since
2.1
columnsback to summary
public ColumnResult[] columns()

Specifies the result set mapping to scalar values.

entitiesback to summary
public EntityResult[] entities()

Specifies the result set mapping to entities.

nameback to summary
public String name()

The name given to the result set mapping, and used to refer to it in the methods of the Query and StoredProcedureQuery APIs.