Package net.sf.jasperreports.j2ee.ejbql
Class JRJpaQueryExecuter
- java.lang.Object
-
- net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
-
- net.sf.jasperreports.j2ee.ejbql.JRJpaQueryExecuter
-
- All Implemented Interfaces:
JRQueryExecuter
public class JRJpaQueryExecuter extends JRAbstractQueryExecuter
EJBQL query executer that uses the Java Persistence API. To use EJBQL in queries, anjavax.persistence.EntityManager
is needed. When running or filling reports theem
need to be supplied with the named parameterEjbqlConstants.PARAMETER_JPA_ENTITY_MANAGER
. Example:Map parameters = new HashMap(); EntityManager em = emf.createEntityManager(); parameters.put(EjbqlConstants.PARAMETER_JPA_ENTITY_MANAGER, em); JasperRunManager.runReportToPdfFile(fileName, parameters);
PROPERTY_JPA_QUERY_PAGE_SIZE
property in the report template. Example:<property name="net.sf.jasperreports.ejbql.query.page.size" value="100"/>
EjbqlConstants.PARAMETER_JPA_QUERY_HINTS_MAP
containing ajava.util.Map
with named/value query hints. Example using report property:<property name="net.sf.jasperreports.ejbql.query.hint.fetchSize" value="100"/>
net.sf.jasperreports.ejbql.query.hint.
. Above example will set a query hint with the namefetchSize
and theString
value100
. Example using map:Map hints = new HashMap(); hints.put("fetchSize", 100); hints.put("anyName", anyObject()); Map parameters = new HashMap(); EntityManager em = emf.createEntityManager(); parameters.put(EjbqlConstants.PARAMETER_JPA_ENTITY_MANAGER, em); parameters.put(EjbqlConstants.PARAMETER_JPA_QUERY_HINTS_MAP, hints); JasperRunManager.runReportToPdfFile(fileName, parameters);
String
values can be set as query hint. When using a query hints map, anyObject
can be set as value.- Author:
- Marcel Overdijk (marceloverdijk@hotmail.com)
- See Also:
JRJpaQueryExecuterFactory
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
JRAbstractQueryExecuter.QueryParameter, JRAbstractQueryExecuter.QueryParameterEntry, JRAbstractQueryExecuter.QueryParameterVisitor, JRAbstractQueryExecuter.ValuedQueryParameter, JRAbstractQueryExecuter.VisitExceptionWrapper
-
-
Field Summary
Fields Modifier and Type Field Description static String
CANONICAL_LANGUAGE
static String
PROPERTY_JPA_QUERY_HINT_PREFIX
Property specifying the prefix for EJBQL query hints.static String
PROPERTY_JPA_QUERY_PAGE_SIZE
Property specifying the number of result rows to be retrieved at once.-
Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
clauseFunctions, dataset, EXCEPTION_MESSAGE_KEY_NUMERIC_TYPE_REQUIRED, EXCEPTION_MESSAGE_KEY_PARAMETER_NOT_FOUND, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_CIRCULARLY_NESTED_PARAMETER, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_ID_FIRST_TOKEN_MISSING, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_NOT_FOUND, EXCEPTION_MESSAGE_KEY_UNSUPPORTED_PARAMETER_TYPE, GET_COLLECTED
-
-
Constructor Summary
Constructors Constructor Description JRJpaQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parameters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
cancelQuery()
Cancels the query if it's currently running.void
close()
Closes resources kept open during the data source iteration.JRDataSource
createDatasource()
Executes the query and creates aJRDataSource
out of the result.protected void
createQuery(String queryString)
Creates the EJBQL query object.protected JRDataSource
createResultDatasource()
Creates a data source out of the query result.protected String
getCanonicalQueryLanguage()
Returns a canonical query language for this query executer implementation.protected String
getEjbqlParameterName(String parameterName)
protected String
getParameterReplacement(String parameterName)
Returns the replacement text for a query parameter.List<?>
getResultList()
Runs the query by callingjavax.persistence.Query.getResultList
.List<?>
getResultList(int firstIndex, int resultCount)
Returns a page of the query results by callingjavax.persistence.Query.getResultList
.-
Methods inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
addQueryMultiParameters, addQueryMultiParameters, addQueryParameter, addQueryParameter, appendClauseChunk, appendParameterChunk, appendParameterClauseChunk, appendQueryChunk, appendTextChunk, applyClause, checkParameter, findExtensionQueryFunction, getBooleanParameter, getBooleanParameter, getBooleanParameterOrProperty, getBooleanParameterOrProperty, getCollectedParameterNames, getCollectedParameters, getIntegerParameter, getIntegerParameter, getIntegerParameterOrProperty, getIntegerParameterOrProperty, getJasperReportsContext, getParameterValue, getParameterValue, getPropertiesUtil, getQueryExecutionContext, getQueryString, getRepositoryContext, getStringParameter, getStringParameterOrProperty, getValueParameter, getValueParameter, parameterHasValue, parseQuery, registerClauseFunction, resolveFunction, unregisterClauseFunction, visitQueryParameters
-
-
-
-
Field Detail
-
CANONICAL_LANGUAGE
public static final String CANONICAL_LANGUAGE
- See Also:
- Constant Field Values
-
PROPERTY_JPA_QUERY_PAGE_SIZE
public static final String PROPERTY_JPA_QUERY_PAGE_SIZE
Property specifying the number of result rows to be retrieved at once. Result pagination is implemented byjavax.persistence.Query.setFirstResult()
andjavax.persistence.Query.setMaxResults()
. By default, all the rows are retrieved (no result pagination is performed).- See Also:
- Constant Field Values
-
PROPERTY_JPA_QUERY_HINT_PREFIX
public static final String PROPERTY_JPA_QUERY_HINT_PREFIX
Property specifying the prefix for EJBQL query hints.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JRJpaQueryExecuter
public JRJpaQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parameters)
-
-
Method Detail
-
getCanonicalQueryLanguage
protected String getCanonicalQueryLanguage()
Description copied from class:JRAbstractQueryExecuter
Returns a canonical query language for this query executer implementation.The canonical language is used to retrieve extensions for the query executer.
The default implementation returns the runtime query language used in the dataset, but query executer implementations should override this method and return a fixed language.
- Overrides:
getCanonicalQueryLanguage
in classJRAbstractQueryExecuter
- Returns:
- a canonical query language
-
createDatasource
public JRDataSource createDatasource() throws JRException
Description copied from interface:JRQueryExecuter
Executes the query and creates aJRDataSource
out of the result.- Returns:
- a
JRDataSource
wrapping the query execution result. - Throws:
JRException
-
createQuery
protected void createQuery(String queryString)
Creates the EJBQL query object.- Parameters:
queryString
- the query string
-
createResultDatasource
protected JRDataSource createResultDatasource()
Creates a data source out of the query result.- Returns:
- the data source
-
close
public void close()
Description copied from interface:JRQueryExecuter
Closes resources kept open during the data source iteration. This method is called after the report is filled or the dataset is iterated. If a resource is not needed after the data source has been created, it should be released at the end ofcreateDatasource
.
-
cancelQuery
public boolean cancelQuery() throws JRException
Description copied from interface:JRQueryExecuter
Cancels the query if it's currently running. This method will be called from a different thread if the client decides to cancel the filling process.- Returns:
true
if and only if the query was running and it has been canceled- Throws:
JRException
-
getParameterReplacement
protected String getParameterReplacement(String parameterName)
Description copied from class:JRAbstractQueryExecuter
Returns the replacement text for a query parameter.- Specified by:
getParameterReplacement
in classJRAbstractQueryExecuter
- Parameters:
parameterName
- the parameter name- Returns:
- the replacement text
- See Also:
JRQueryChunk.TYPE_PARAMETER
-
getResultList
public List<?> getResultList()
Runs the query by callingjavax.persistence.Query.getResultList
. All the result rows are returned.- Returns:
- the result of the query as a list
-
getResultList
public List<?> getResultList(int firstIndex, int resultCount)
Returns a page of the query results by callingjavax.persistence.Query.getResultList
.- Parameters:
firstIndex
- the index of the first row to returnresultCount
- the number of rows to return- Returns:
- result row list
-
-