net.sf.jasperreports.engine.query
Class JRJdbcQueryExecuter

java.lang.Object
  extended by net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
      extended by net.sf.jasperreports.engine.query.JRJdbcQueryExecuter
All Implemented Interfaces:
JRQueryExecuter

public class JRJdbcQueryExecuter
extends JRAbstractQueryExecuter

JDBC query executer for SQL queries.

This query executer implementation offers built-in support for SQL queries.

Version:
$Id: JRJdbcQueryExecuter.java 1959 2007-11-14 15:08:22Z lucianc $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary
 
Nested classes/interfaces inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
JRAbstractQueryExecuter.QueryParameter
 
Field Summary
protected static java.lang.String CLAUSE_ID_IN
           
protected static java.lang.String CLAUSE_ID_NOTIN
           
 
Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
CLAUSE_POSITION_ID, clauseFunctions, dataset
 
Constructor Summary
JRJdbcQueryExecuter(JRDataset dataset, java.util.Map parameters)
           
 
Method Summary
 boolean cancelQuery()
          Cancels the query if it's currently running.
 void close()
          Closes resources kept open during the data source iteration.
 JRDataSource createDatasource()
          Executes the query and creates a JRDataSource out of the result.
protected  java.lang.String getParameterReplacement(java.lang.String parameterName)
          Returns the replacement text for a query paramter.
protected  void registerFunctions()
          Registers built-in clause functions.
protected  void setStatementMultiParameter(int parameterIndex, java.lang.String parameterName, int valueIndex, java.lang.Object value)
           
protected  int setStatementMultiParameters(int parameterIndex, java.lang.String parameterName)
           
protected  void setStatementParameter(int parameterIndex, java.lang.Class parameterType, java.lang.Object parameterValue)
           
protected  void setStatementParameter(int parameterIndex, java.lang.String parameterName)
           
 
Methods inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
addQueryMultiParameters, addQueryParameter, appendClauseChunk, appendParameterChunk, appendParameterClauseChunk, appendQueryChunk, appendTextChunk, applyClause, checkParameter, getCollectedParameterNames, getCollectedParameters, getParameter, getParameterValue, getParameterValue, getQueryString, getValueParameter, getValueParameter, parseQuery, registerClauseFunction, resolveFunction, unregisterClauseFunction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLAUSE_ID_IN

protected static final java.lang.String CLAUSE_ID_IN
See Also:
Constant Field Values

CLAUSE_ID_NOTIN

protected static final java.lang.String CLAUSE_ID_NOTIN
See Also:
Constant Field Values
Constructor Detail

JRJdbcQueryExecuter

public JRJdbcQueryExecuter(JRDataset dataset,
                           java.util.Map parameters)
Method Detail

registerFunctions

protected void registerFunctions()
Registers built-in clause functions.

See Also:
registerFunctions(), JRAbstractQueryExecuter.appendClauseChunk(StringBuffer, String[])

getParameterReplacement

protected java.lang.String getParameterReplacement(java.lang.String parameterName)
Description copied from class: JRAbstractQueryExecuter
Returns the replacement text for a query paramter.

Specified by:
getParameterReplacement in class JRAbstractQueryExecuter
Parameters:
parameterName - the paramter name
Returns:
the replacement text
See Also:
JRQueryChunk.TYPE_PARAMETER

createDatasource

public JRDataSource createDatasource()
                              throws JRException
Description copied from interface: JRQueryExecuter
Executes the query and creates a JRDataSource out of the result.

Returns:
a JRDataSource wrapping the query execution result.
Throws:
JRException

setStatementParameter

protected void setStatementParameter(int parameterIndex,
                                     java.lang.String parameterName)
                              throws java.sql.SQLException
Throws:
java.sql.SQLException

setStatementMultiParameters

protected int setStatementMultiParameters(int parameterIndex,
                                          java.lang.String parameterName)
                                   throws java.sql.SQLException
Throws:
java.sql.SQLException

setStatementMultiParameter

protected void setStatementMultiParameter(int parameterIndex,
                                          java.lang.String parameterName,
                                          int valueIndex,
                                          java.lang.Object value)
                                   throws java.sql.SQLException
Throws:
java.sql.SQLException

setStatementParameter

protected void setStatementParameter(int parameterIndex,
                                     java.lang.Class parameterType,
                                     java.lang.Object parameterValue)
                              throws java.sql.SQLException
Throws:
java.sql.SQLException

close

public void close()
Description copied from interface: JRQueryExecuter
Closes resources kept open during the data source iteration.

This method is called after the report is filled or the dataset is iterated. If a resource is not needed after the data source has been created, it should be released at the end of createDatasource.


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 iff the query was running and it has been cancelled
Throws:
JRException


© 2001-2006 JasperSoft Corporation www.jaspersoft.com