Package net.sf.jasperreports.engine.query

Class JRHibernateQueryExecuterFactory

java.lang.Object

net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory

net.sf.jasperreports.engine.query.JRHibernateQueryExecuterFactory

All Implemented Interfaces:

JRQueryExecuterFactory, QueryExecuterFactory, Designated

public class JRHibernateQueryExecuterFactory
extends AbstractQueryExecuterFactory
implements Designated

Query executer factory for HQL queries that uses Hibernate 3.

The factory creates JRHibernateQueryExecuter query executers.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static String	PARAMETER_HIBERNATE_FILTER_COLLECTION	Built-in parameter used for collection filter queries.
static String	PARAMETER_HIBERNATE_SESSION	Built-in parameter holding the value of the Hibernate session to be used for creating the query.
static String	PROPERTY_HIBERNATE_CLEAR_CACHE	Property specifying whether hibernate session cache should be cleared between two consecutive fetches when using pagination.
static String	PROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS	Property specifying whether field descriptions should be used to determine the mapping between the fields and the query return values.
static String	PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE	Property specifying the number of result rows to be retrieved at once when the execution type is list.
static String	PROPERTY_HIBERNATE_QUERY_RUN_TYPE	Property specifying the query execution type.
static String	QUERY_EXECUTER_NAME
static String	QUERY_LANGUAGE_HQL	HQL query language.
static String	VALUE_HIBERNATE_QUERY_RUN_TYPE_ITERATE	Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to iterate execution type.
static String	VALUE_HIBERNATE_QUERY_RUN_TYPE_LIST	Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to list execution type.
static String	VALUE_HIBERNATE_QUERY_RUN_TYPE_SCROLL	Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to scroll execution type.

Fields inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory

QUERY_EXECUTER_FACTORY_PREFIX

Constructor Summary

Constructors

Constructor	Description
JRHibernateQueryExecuterFactory()

Method Summary

Modifier and Type	Method	Description
JRQueryExecuter	createQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parameters)	Creates a query executer.
Object[]	getBuiltinParameters()	Returns an array containing the PARAMETER_HIBERNATE_SESSION and PARAMETER_HIBERNATE_FILTER_COLLECTION parameters.
String	getDesignation()
boolean	supportsQueryParameterType(String className)	Returns true for all parameter types.

Methods inherited from class net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory

createQueryExecuter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory

createQueryExecuter

Field Detail

QUERY_EXECUTER_NAME

public static final String QUERY_EXECUTER_NAME

See Also:

Constant Field Values

QUERY_LANGUAGE_HQL

public static final String QUERY_LANGUAGE_HQL

HQL query language.

See Also:

Constant Field Values

PARAMETER_HIBERNATE_SESSION

public static final String PARAMETER_HIBERNATE_SESSION

Built-in parameter holding the value of the Hibernate session to be used for creating the query.

See Also:

Constant Field Values

PARAMETER_HIBERNATE_FILTER_COLLECTION

public static final String PARAMETER_HIBERNATE_FILTER_COLLECTION

Built-in parameter used for collection filter queries.

The value of this parameter will be used as the collection to filter using the query.

See Also:

Constant Field Values

PROPERTY_HIBERNATE_QUERY_RUN_TYPE

public static final String PROPERTY_HIBERNATE_QUERY_RUN_TYPE

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()

See Also:

Constant Field Values

PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE

public static final String PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE

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).

See Also:

Constant Field Values

PROPERTY_HIBERNATE_CLEAR_CACHE

public static final String PROPERTY_HIBERNATE_CLEAR_CACHE

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 Also:

PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE, Constant Field Values

PROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS

public static final String PROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS

Property specifying whether field descriptions should be used to determine the mapping between the fields and the query return values.

See Also:

Constant Field Values

VALUE_HIBERNATE_QUERY_RUN_TYPE_LIST

public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_LIST

Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to list execution type.

See Also:

Constant Field Values

VALUE_HIBERNATE_QUERY_RUN_TYPE_ITERATE

public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_ITERATE

Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to iterate execution type.

See Also:

Constant Field Values

VALUE_HIBERNATE_QUERY_RUN_TYPE_SCROLL

public static final String VALUE_HIBERNATE_QUERY_RUN_TYPE_SCROLL

Value of the PROPERTY_HIBERNATE_QUERY_RUN_TYPE property corresponding to scroll execution type.

See Also:

Constant Field Values

Constructor Detail

JRHibernateQueryExecuterFactory

public JRHibernateQueryExecuterFactory()

Method Detail

getBuiltinParameters

public Object[] getBuiltinParameters()

Returns an array containing the PARAMETER_HIBERNATE_SESSION and PARAMETER_HIBERNATE_FILTER_COLLECTION parameters.

Specified by:

getBuiltinParameters in interface JRQueryExecuterFactory

Specified by:

getBuiltinParameters in interface QueryExecuterFactory

Returns:

array of built-in parameter names and types associated with this query type

createQueryExecuter

public JRQueryExecuter createQueryExecuter(JasperReportsContext jasperReportsContext,
                                           JRDataset dataset,
                                           Map<String,? extends JRValueParameter> parameters)
                                    throws JRException

Description copied from interface: QueryExecuterFactory

Creates a query executer.

This method is called at fill time for reports/datasets having a query supported by this factory.

Specified by:

createQueryExecuter in interface QueryExecuterFactory

Parameters:

jasperReportsContext - the JasperReportsContext

dataset - the dataset containing the query, fields, etc

parameters - map of value parameters (instances of JRValueParameter) indexed by name

Returns:

a query executer

Throws:

JRException

supportsQueryParameterType

public boolean supportsQueryParameterType(String className)

Returns true for all parameter types.

Specified by:

supportsQueryParameterType in interface JRQueryExecuterFactory

Specified by:

supportsQueryParameterType in interface QueryExecuterFactory

Parameters:

className - the value class name of the parameter

Returns:

whether the parameter value type is supported

getDesignation

public String getDesignation()

Specified by:

getDesignation in interface Designated