net.sf.jasperreports.engine.query
Class JRJdbcQueryExecuterFactory

java.lang.Object
  extended by net.sf.jasperreports.engine.query.JRJdbcQueryExecuterFactory
All Implemented Interfaces:
JRQueryExecuterFactory

public class JRJdbcQueryExecuterFactory
extends java.lang.Object
implements JRQueryExecuterFactory

Query executer factory for SQL queries.

This factory creates JDBC query executers for SQL queries.

Version:
$Id: JRJdbcQueryExecuterFactory.java 3034 2009-08-27 11:58:04Z teodord $
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:
JRJdbcQueryExecuter

Field Summary
static java.lang.String PROPERTY_JDBC_CONCURRENCY
          Property specifying the ResultSet concurrency.
static java.lang.String PROPERTY_JDBC_FETCH_SIZE
          Property specifying the ResultSet fetch size.
static java.lang.String PROPERTY_JDBC_HOLDABILITY
          Property specifying the ResultSet holdability.
static java.lang.String PROPERTY_JDBC_MAX_FIELD_SIZE
          Property specifying the statement max field size.
static java.lang.String PROPERTY_JDBC_RESULT_SET_TYPE
          Property specifying the ResultSet type.
static java.lang.String QUERY_LANGUAGE_SQL
          SQL query language.
 
Fields inherited from interface net.sf.jasperreports.engine.query.JRQueryExecuterFactory
QUERY_EXECUTER_FACTORY_PREFIX
 
Constructor Summary
JRJdbcQueryExecuterFactory()
           
 
Method Summary
 JRQueryExecuter createQueryExecuter(JRDataset dataset, java.util.Map parameters)
          Creates a query executer.
 java.lang.Object[] getBuiltinParameters()
          Returns the built-in parameters associated with this query type.
 boolean supportsQueryParameterType(java.lang.String className)
          Decides whether the query executers created by this factory support a query parameter type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_JDBC_FETCH_SIZE

public static final java.lang.String PROPERTY_JDBC_FETCH_SIZE
Property specifying the ResultSet fetch size.

See Also:
Constant Field Values

PROPERTY_JDBC_RESULT_SET_TYPE

public static final java.lang.String PROPERTY_JDBC_RESULT_SET_TYPE
Property specifying the ResultSet type.

See Also:
Constant Field Values

PROPERTY_JDBC_CONCURRENCY

public static final java.lang.String PROPERTY_JDBC_CONCURRENCY
Property specifying the ResultSet concurrency.

See Also:
Constant Field Values

PROPERTY_JDBC_HOLDABILITY

public static final java.lang.String PROPERTY_JDBC_HOLDABILITY
Property specifying the ResultSet holdability.

See Also:
Constant Field Values

PROPERTY_JDBC_MAX_FIELD_SIZE

public static final java.lang.String PROPERTY_JDBC_MAX_FIELD_SIZE
Property specifying the statement max field size.

See Also:
Constant Field Values

QUERY_LANGUAGE_SQL

public static final java.lang.String QUERY_LANGUAGE_SQL
SQL query language.

See Also:
Constant Field Values
Constructor Detail

JRJdbcQueryExecuterFactory

public JRJdbcQueryExecuterFactory()
Method Detail

createQueryExecuter

public JRQueryExecuter createQueryExecuter(JRDataset dataset,
                                           java.util.Map parameters)
                                    throws JRException
Description copied from interface: JRQueryExecuterFactory
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 JRQueryExecuterFactory
Parameters:
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

getBuiltinParameters

public java.lang.Object[] getBuiltinParameters()
Description copied from interface: JRQueryExecuterFactory
Returns the built-in parameters associated with this query type.

These parameters will be created as system-defined parameters for each report/dataset having a query of this type.

The returned array should contain consecutive pairs of parameter names and parameter classes (e.g. {"Param1", String.class, "Param2", "List.class"}).

Specified by:
getBuiltinParameters in interface JRQueryExecuterFactory
Returns:
array of built-in parameter names and types associated with this query type

supportsQueryParameterType

public boolean supportsQueryParameterType(java.lang.String className)
Description copied from interface: JRQueryExecuterFactory
Decides whether the query executers created by this factory support a query parameter type.

This check is performed for all $P{..} parameters in the query.

Specified by:
supportsQueryParameterType in interface JRQueryExecuterFactory
Parameters:
className - the value class name of the parameter
Returns:
whether the parameter value type is supported


© 2001-2009 Jaspersoft Corporation www.jaspersoft.com