net.sf.jasperreports.engine.query.JRHibernateQueryExecuterFactory Maven / Gradle / Ivy
/*
* ============================================================================
* GNU Lesser General Public License
* ============================================================================
*
* JasperReports - Free Java report-generating library.
* Copyright (C) 2001-2009 JasperSoft Corporation http://www.jaspersoft.com
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*
* JasperSoft Corporation
* 539 Bryant Street, Suite 100
* San Francisco, CA 94107
* http://www.jaspersoft.com
*/
package net.sf.jasperreports.engine.query;
import java.util.Map;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.util.JRProperties;
import org.hibernate.Session;
/**
* Query executer factory for HQL queries that uses Hibernate 3.
*
* The factory creates {@link net.sf.jasperreports.engine.query.JRHibernateQueryExecuter JRHibernateQueryExecuter}
* query executers.
*
* @author Lucian Chirita ([email protected])
* @version $Id: JRHibernateQueryExecuterFactory.java 2697 2009-03-24 18:41:23Z teodord $
*/
public class JRHibernateQueryExecuterFactory implements JRQueryExecuterFactory
{
/**
* HQL query language.
*/
public static final String QUERY_LANGUAGE_HQL = "hql";
/**
* Built-in parameter holding the value of the Hibernate session to be used for creating the query.
*/
public final static String PARAMETER_HIBERNATE_SESSION = "HIBERNATE_SESSION";
/**
* Built-in parameter used for collection filter queries.
*
* The value of this paramter will be used as the collection to filter using the query.
*/
public final static String PARAMETER_HIBERNATE_FILTER_COLLECTION = "HIBERNATE_FILTER_COLLECTION";
private final static Object[] HIBERNATE_BUILTIN_PARAMETERS = {
PARAMETER_HIBERNATE_SESSION, Session.class,
PARAMETER_HIBERNATE_FILTER_COLLECTION, Object.class,
};
/**
* Property specifying the query execution type.
*
* Possible values are:
*
* - list (default) - the query will be run by calling
org.hibernate.Query.list()
* - iterate - the query will be run by calling
org.hibernate.Query.iterate()
* - scroll - the query will be run by calling
org.hibernate.Query.scroll()
*
*/
public static final String PROPERTY_HIBERNATE_QUERY_RUN_TYPE = JRProperties.PROPERTY_PREFIX + "hql.query.run.type";
/**
* Property specifying the number of result rows to be retrieved at once when the execution type is list.
*
* Result pagination is implemented by org.hibernate.Query.setFirstResult() and org.hibernate.Query.setMaxResults().
*
* By default, all the rows are retrieved (no result pagination is performed).
*/
public static final String PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE = JRProperties.PROPERTY_PREFIX + "hql.query.list.page.size";
/**
* Property specifying whether hibernate session cache should be cleared between two consecutive fetches when using pagination.
*
* By default, the cache cleanup is not performed.
*
* @see net.sf.jasperreports.engine.query.JRHibernateQueryExecuterFactory#PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE
*/
public static final String PROPERTY_HIBERNATE_CLEAR_CACHE = JRProperties.PROPERTY_PREFIX + "hql.clear.cache";
/**
* Property specifying whether field descriptions should be used to determine the mapping between the fields
* and the query return values.
*/
public static final String PROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS = JRProperties.PROPERTY_PREFIX + "hql.field.mapping.descriptions";
/**
* Value of the {@link #PROPERTY_HIBERNATE_QUERY_RUN_TYPE PROPERTY_HIBERNATE_QUERY_RUN_TYPE} property
* corresponding to list execution type.
*/
public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_LIST = "list";
/**
* Value of the {@link #PROPERTY_HIBERNATE_QUERY_RUN_TYPE PROPERTY_HIBERNATE_QUERY_RUN_TYPE} property
* corresponding to iterate execution type.
*/
public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_ITERATE = "iterate";
/**
* Value of the {@link #PROPERTY_HIBERNATE_QUERY_RUN_TYPE PROPERTY_HIBERNATE_QUERY_RUN_TYPE} property
* corresponding to scroll execution type.
*/
public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_SCROLL = "scroll";
/**
* Returns an array containing the {@link #PARAMETER_HIBERNATE_SESSION PARAMETER_HIBERNATE_SESSION} and
* {@link #PARAMETER_HIBERNATE_FILTER_COLLECTION PARAMETER_HIBERNATE_FILTER_COLLECTION} paramters.
*/
public Object[] getBuiltinParameters()
{
return HIBERNATE_BUILTIN_PARAMETERS;
}
public JRQueryExecuter createQueryExecuter(JRDataset dataset, Map parameters) throws JRException
{
return new JRHibernateQueryExecuter(dataset, parameters);
}
/**
* Returns true for all parameter types.
*/
public boolean supportsQueryParameterType(String className)
{
return true;
}
}