• PARAMETER_JPA_ENTITY_MANAGER - that specifies the entity manager to be used for executing the query, depending on the particular EJB/JPA environment and implementation
• JPA_QUERY_HINTS_MAP - that contains a map with hint values mapped on hint names, to be used when running the query. Hints can also be specified statically by using report properties. The query executer treats any report property in the category net.sf.jasperreports.ejbql.query.hint.{hintName} as a hint by interpreting the property suffix as the hint name and the property value as the hint value.

<property name="net.sf.jasperreports.ejbql.query.hint.cacheType" value="Shared"/>

<property name="net.sf.jasperreports.ejbql.query.page.size" value="500"/>

• Queries returning a single entity/bean per row - in this case field mappings are interpreted as bean property names.
• Queries returning object tuples as rows - fields are mapped using one of the following forms:
  • COLUMN_<index> - the field is mapped to a value specified by its position in the resulting tuple. The positions start from 1.
  • COLUMN_<index>.<property> - the field is mapped to a property of a value specified by its position in the resulting tuple.

• the data directory contains the SQL script that creates and populates the following tables in the built-in HSQL database:
  • PERSON - stores people IDs and names
  • MOVIE - stores movie ID, director, title, genre and release date informations
  • MOVIE_CAST - stores ID, movie ID, actor ID, character and role importance
  • MOVIE_VARIA - stores ID, movie ID, type, description, importance
• the docs directory contains the xml file used to generate this documentation
• the lib directory contains 3-rd party jars with necessary persistence APIs
• the reports directory contains, as usual, report templates (1 master and 2 subreports)
• the src directory contains
  • a META-INF subdirectory with the persistence.xml persistence configuration file:

    <persistence-unit name="pu1">
      <!-- Provider class name is required in Java SE -->
      <provider>oracle.toplink.essentials.ejb.cmp3.EntityManagerFactoryProvider</provider>
      <!-- All persistence classes must be listed -->
      <class>Person</class>
      <class>Movie</class>
      <class>Cast</class>
      <class>Varia</class>    
      <properties>
        <!-- Provider-specific connection properties -->
        <property name="toplink.jdbc.driver" value="org.hsqldb.jdbcDriver"/>
        <property name="toplink.jdbc.url" value="jdbc:hsqldb:file:build/db"/>
        <property name="toplink.jdbc.user" value="sa"/>
        <property name="toplink.jdbc.password" value=""/>
        <!-- Provider-specific settings -->
        <property name="toplink.logging.level" value="DEBUG"/>
        <property name="toplink.platform.class.name" value="oracle.toplink.essentials.platform.database.HSQLPlatform"/>
      </properties>    
    </persistence-unit>

  • the annotated entity classes mapped on the tables in the database: Person, Movie, Cast and Varia. Corresponding tables are specified in the @Table annotation:

    @Entity
    @Table(name="movie_cast")
    public class Cast {
    ...
    }

  • the EjbqlApp.java file that hosts the main method.

...
<property name="net.sf.jasperreports.ejbql.query.hint.fetchSize" value="50"/>
<property name="net.sf.jasperreports.ejbql.query.page.size" value="100"/>
<import value="net.sf.jasperreports.engine.data.JRBeanCollectionDataSource"/>
...
<queryString language="ejbql">
  <![CDATA[SELECT   m
    FROM     Movie m
    WHERE    m.releaseDate BETWEEN $P{DateFrom} AND $P{DateTo}
    ORDER BY $P!{OrderClause}]] >
</queryString>
<field name="id" class="java.lang.Integer"/>
<field name="director.name" class="java.lang.String"/>
<field name="title" class="java.lang.String"/>
<field name="genre" class="java.lang.String"/>
<field name="releaseDate" class="java.sql.Date"/>
<field name="cast" class="java.util.Collection"/>
...
<detail>
  <band height="45">
    ...
    <subreport>
      <reportElement positionType="Float" x="15" y="25" width="245" height="20" isRemoveLineWhenBlank="true" backcolor="#99CCFF"/>
      <dataSourceExpression><![CDATA[new JRBeanCollectionDataSource($F{cast})]] ></dataSourceExpression>
      <subreportExpression class="java.lang.String"><![CDATA["JRMDbCastSubreport.jasper"]] ></subreportExpression>
    </subreport>
    <subreport>
      <reportElement positionType="Float" x="270" y="25" width="245" height="20" isRemoveLineWhenBlank="true" backcolor="#99CCFF"/>
      <subreportParameter name="MovieId">
        <subreportParameterExpression><![CDATA[$F{id}]] ></subreportParameterExpression>
      </subreportParameter>
      <subreportParameter name="JPA_ENTITY_MANAGER">
        <subreportParameterExpression><![CDATA[$P{JPA_ENTITY_MANAGER}]] ></subreportParameterExpression>
      </subreportParameter>
      <subreportExpression class="java.lang.String"><![CDATA["JRMDbVariaSubreport.jasper"]] ></subreportExpression>
    </subreport>
  </band>
</detail>
...

<field name="actor.name" class="java.lang.String"/>
<field name="character" class="java.lang.String"/>

...
<parameter name="MovieId" class="java.lang.Integer"/>
<queryString language="ejbql">
  <![CDATA[SELECT   v.type, v.description
    FROM     Varia v
    WHERE    v.movie.id = $P{MovieId}
    ORDER BY v.importance]] >
</queryString>
<field name="type" class="java.lang.String">
  <fieldDescription><![CDATA[COLUMN_1]] ></fieldDescription>
</field>
<field name="description" class="java.lang.String">
  <fieldDescription><![CDATA[COLUMN_2]] ></fieldDescription>
</field>
...