net.sf.jasperreports.engine.query
Class JRXlsxQueryExecuter

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

public class JRXlsxQueryExecuter
extends JRAbstractQueryExecuter

XLS query executer implementation.

Version:
$Id: JRXlsxQueryExecuter.java 5180 2012-03-29 13:23:12Z teodord $
Author:
sanda zaharia (shertage@users.sourceforge.net)

Nested Class Summary
 
Nested classes/interfaces inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
JRAbstractQueryExecuter.QueryParameter
 
Field Summary
 
Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
CLAUSE_POSITION_ID, clauseFunctions, dataset
 
Constructor Summary
protected JRXlsxQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parametersMap)
           
protected JRXlsxQueryExecuter(JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parametersMap)
          Deprecated. Replaced by JRXlsxQueryExecuter(JasperReportsContext, JRDataset, Map).
 
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 parameter.
 
Methods inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
addQueryMultiParameters, addQueryMultiParameters, addQueryParameter, appendClauseChunk, appendParameterChunk, appendParameterClauseChunk, appendQueryChunk, appendTextChunk, applyClause, checkParameter, getBooleanParameter, getBooleanParameterOrProperty, getCollectedParameterNames, getCollectedParameters, getJasperReportsContext, getParameter, getParameterValue, getParameterValue, getPropertiesUtil, getQueryString, getStringParameter, getStringParameterOrProperty, getValueParameter, getValueParameter, parameterHasValue, parseQuery, registerClauseFunction, resolveFunction, unregisterClauseFunction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JRXlsxQueryExecuter

protected JRXlsxQueryExecuter(JasperReportsContext jasperReportsContext,
                              JRDataset dataset,
                              java.util.Map<java.lang.String,? extends JRValueParameter> parametersMap)

JRXlsxQueryExecuter

protected JRXlsxQueryExecuter(JRDataset dataset,
                              java.util.Map<java.lang.String,? extends JRValueParameter> parametersMap)
Deprecated. Replaced by JRXlsxQueryExecuter(JasperReportsContext, JRDataset, Map).

Method Detail

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

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 if and only if the query was running and it has been canceled
Throws:
JRException

getParameterReplacement

protected java.lang.String getParameterReplacement(java.lang.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


© 2001-2010 Jaspersoft Corporation www.jaspersoft.com