Package net.sf.jasperreports.j2ee.hibernate

Class JRHibernateQueryExecuterFactory

java.lang.Object

net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory

net.sf.jasperreports.j2ee.hibernate.JRHibernateQueryExecuterFactory

All Implemented Interfaces:

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 Object[]	HIBERNATE_BUILTIN_PARAMETERS
static String	PARAMETER_HIBERNATE_FILTER_COLLECTION	Built-in parameter used for collection filter queries.

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

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

HIBERNATE_BUILTIN_PARAMETERS

public static final Object[] HIBERNATE_BUILTIN_PARAMETERS

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