Package javax.persistence

Annotation Type EntityResult

  • @Target({})
@Retention(RUNTIME)
public @interface EntityResult
    Used in conjunction with the SqlResultSetMapping annotation to map the SELECT clause of a SQL query to an entity result.

    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. 

       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)
   })
    See Also:
    SqlResultSetMapping
    Since:
    1.0

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class entityClass
      The class of the result.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String discriminatorColumn
      Specifies the column name (or alias) of the column in the SELECT list that is used to determine the type of the entity instance.
      FieldResult[] fields
      Maps the columns specified in the SELECT list of the query to the properties or fields of the entity class.

    • Element Detail

      • entityClass

        java.lang.Class entityClass
        The class of the result.

      • fields

        FieldResult[] fields
        Maps the columns specified in the SELECT list of the query to the properties or fields of the entity class.
        Default:
        {}

      • discriminatorColumn

        java.lang.String discriminatorColumn
        Specifies the column name (or alias) of the column in the SELECT list that is used to determine the type of the entity instance.
        Default:
        ""