net.sf.jasperreports.engine.query.JRJpaQueryExecuterFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2022 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.engine.query;
import java.util.Map;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRValueParameter;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.util.Designated;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Java Persistence API query executer factory for EJBQL queries.
*
* The factory creates {@link net.sf.jasperreports.engine.query.JRJpaQueryExecuter JRJpaQueryExecuter}
* query executers.
*
* @author Marcel Overdijk ([email protected])
*/
public class JRJpaQueryExecuterFactory extends AbstractQueryExecuterFactory implements Designated
{
public static final String QUERY_EXECUTER_NAME = "net.sf.jasperreports.query.executer:EJBQL";
/**
* EJBQL query language.
*/
public static final String QUERY_LANGUAGE_EJBQL = "ejbql";
/**
* Built-in parameter holding the value of the javax.persistence.EntityManager
to be used for creating the query.
*/
public static final String PARAMETER_JPA_ENTITY_MANAGER = "JPA_ENTITY_MANAGER";
/**
* Built-in parameter (optional) holding the value of the query hints map.
* Each named/value pair will be set as query hint against the query.
*/
public static final String PARAMETER_JPA_QUERY_HINTS_MAP = "JPA_QUERY_HINTS_MAP";
private static final Object[] JPA_BUILTIN_PARAMETERS = {
PARAMETER_JPA_ENTITY_MANAGER, "javax.persistence.EntityManager",
PARAMETER_JPA_QUERY_HINTS_MAP, "java.util.Map"
};
@Override
public Object[] getBuiltinParameters() {
return JPA_BUILTIN_PARAMETERS;
}
/**
* Property specifying the number of result rows to be retrieved at once.
*
* Result pagination is implemented by javax.persistence.Query.setFirstResult()
and javax.persistence.Query.setMaxResults()
.
*
* By default, all the rows are retrieved (no result pagination is performed).
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_1_2_3,
valueType = Integer.class
)
public static final String PROPERTY_JPA_QUERY_PAGE_SIZE = JRPropertiesUtil.PROPERTY_PREFIX + "ejbql.query.page.size";
/**
* Property specifying the prefix for EJBQL query hints.
*/
@Property(
name = "net.sf.jasperreports.ejbql.query.hint.{hint}",
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.DATASET},
scopeQualifications = {QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_1_2_3
)
public static final String PROPERTY_JPA_QUERY_HINT_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "ejbql.query.hint.";
@Override
public JRQueryExecuter createQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parameters
) throws JRException
{
return new JRJpaQueryExecuter(jasperReportsContext, dataset, parameters);
}
/**
* Returns true
for all parameter types.
*/
@Override
public boolean supportsQueryParameterType(String className) {
return true;
}
@Override
public String getDesignation()
{
return QUERY_EXECUTER_NAME;
}
}