java.lang.Object
- net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
- - net.sf.jasperreports.j2ee.hibernate.JRHibernateQueryExecuter

All Implemented Interfaces:

JRQueryExecuter
```
public class JRHibernateQueryExecuter
extends JRAbstractQueryExecuter
```
HQL query executer that uses Hibernate 3.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

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`	`EXCEPTION_MESSAGE_KEY_UNKNOWN_QUERY_RUN_TYPE`
`static String`	`EXCEPTION_MESSAGE_KEY_UNRESOLVED_TYPE_CONSTANT`

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
`JRHibernateQueryExecuter(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`	`clearCache()`
`void`	`close()`	Closes the scrollable result when scroll execution type is used.
`void`	`closeScrollableResults()`	Closes the scrollable results of the query.
`JRDataSource`	`createDatasource()`	Creates an instance of `JRHibernateListDataSource`, `JRHibernateIterateDataSource` or `JRHibernateScrollDataSource`, depending on the
`protected void`	`createQuery(String queryString)`	Creates the Hibernate 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.
`JRDataset`	`getDataset()`	Returns the dataset for which the query executer has been created.
`protected String`	`getHqlParameterName(String parameterName)`
`protected String`	`getParameterReplacement(String parameterName)`	Returns the replacement text for a query parameter.
`String[]`	`getReturnAliases()`	Returns the aliases of the HQL query.
`org.hibernate.type.Type[]`	`getReturnTypes()`	Returns the return types of the HQL query.
`Iterator<?>`	`iterate()`	Runs the query by calling `org.hibernate.Query.iterate()`.
`List<?>`	`list()`	Runs the query by calling `org.hibernate.Query.list()`.
`List<?>`	`list(int firstIndex, int resultCount)`	Returns a page of the query results by calling `org.hibernate.Query.iterate()`.
`org.hibernate.ScrollableResults`	`scroll()`	Runs the query by calling `org.hibernate.Query.scroll()`.
`protected void`	`setParameter(JRValueParameter parameter)`	Binds a parameter value to a query parameter.
`protected void`	`setParameters()`	Binds values for all the query parameters.
`protected void`	`setQueryRunning(boolean queryRunning)`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXCEPTION_MESSAGE_KEY_UNKNOWN_QUERY_RUN_TYPE
```
public static final String EXCEPTION_MESSAGE_KEY_UNKNOWN_QUERY_RUN_TYPE
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_MESSAGE_KEY_UNRESOLVED_TYPE_CONSTANT
```
public static final String EXCEPTION_MESSAGE_KEY_UNRESOLVED_TYPE_CONSTANT
```
    See Also:
    
    Constant Field Values
  - CANONICAL_LANGUAGE
```
public static final String CANONICAL_LANGUAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JRHibernateQueryExecuter
```
public JRHibernateQueryExecuter(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 class JRAbstractQueryExecuter
    
    Returns:
    
    a canonical query language
  - createDatasource
```
public JRDataSource createDatasource()
                              throws JRException
```
    Creates an instance of JRHibernateListDataSource, JRHibernateIterateDataSource or JRHibernateScrollDataSource, depending on the
    
    Returns:
    
    a JRDataSource wrapping the query execution result.
    
    Throws:
    
    JRException
  - createResultDatasource
```
protected JRDataSource createResultDatasource()
```
    Creates a data source out of the query result.
    
    Returns:
    
    the data source
  - createQuery
```
protected void createQuery(String queryString)
```
    Creates the Hibernate query object.
    If the value of the PARAMETER_HIBERNATE_FILTER_COLLECTION is not null, then a filter query is created using the value of the parameter as the collection.
    
    Parameters:
    
    queryString - the query string
  - setParameters
```
protected void setParameters()
```
    Binds values for all the query parameters.
  - setParameter
```
protected void setParameter(JRValueParameter parameter)
```
    Binds a parameter value to a query parameter.
    
    Parameters:
    
    parameter - the report parameter
  - close
```
public void close()
```
    Closes the scrollable result when scroll execution type is used.
  - closeScrollableResults
```
public void closeScrollableResults()
```
    Closes the scrollable results of the query.
  - 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 class JRAbstractQueryExecuter
    
    Parameters:
    
    parameterName - the parameter name
    
    Returns:
    
    the replacement text
    
    See Also:
    
    JRQueryChunk.TYPE_PARAMETER
  - getHqlParameterName
```
protected String getHqlParameterName(String parameterName)
```
  - getReturnTypes
```
public org.hibernate.type.Type[] getReturnTypes()
```
    Returns the return types of the HQL query.
    
    Returns:
    
    the return types of the HQL query
  - getReturnAliases
```
public String[] getReturnAliases()
```
    Returns the aliases of the HQL query.
    
    Returns:
    
    the aliases of the HQL query
  - getDataset
```
public JRDataset getDataset()
```
    Returns the dataset for which the query executer has been created.
    
    Returns:
    
    the dataset for which the query executer has been created
  - list
```
public List<?> list()
```
    Runs the query by calling org.hibernate.Query.list().
    All the result rows are returned.
    
    Returns:
    
    the result of the query as a list
  - setQueryRunning
```
protected void setQueryRunning(boolean queryRunning)
```
  - list
```
public List<?> list(int firstIndex,
                    int resultCount)
```
    Returns a page of the query results by calling org.hibernate.Query.iterate().
    
    Parameters:
    
    firstIndex - the index of the first row to return
    
    resultCount - the number of rows to return
    
    Returns:
    
    result row list
  - iterate
```
public Iterator<?> iterate()
```
    Runs the query by calling org.hibernate.Query.iterate().
    
    Returns:
    
    query iterator
  - scroll
```
public org.hibernate.ScrollableResults scroll()
```
    Runs the query by calling org.hibernate.Query.scroll().
    
    Returns:
    
    scrollable results of the query
  - clearCache
```
public void clearCache()
```

Class JRHibernateQueryExecuter

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

Field Summary

Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

EXCEPTION_MESSAGE_KEY_UNKNOWN_QUERY_RUN_TYPE

EXCEPTION_MESSAGE_KEY_UNRESOLVED_TYPE_CONSTANT

CANONICAL_LANGUAGE

Constructor Detail

JRHibernateQueryExecuter

Method Detail

getCanonicalQueryLanguage

createDatasource

createResultDatasource

createQuery

setParameters

setParameter

close

closeScrollableResults

cancelQuery

getParameterReplacement

getHqlParameterName

getReturnTypes

getReturnAliases

getDataset

list

setQueryRunning

list

iterate

scroll

clearCache