net.sf.jasperreports.engine.query

Class JRCsvQueryExecuter

java.lang.Object

net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

net.sf.jasperreports.engine.query.JRCsvQueryExecuter

All Implemented Interfaces:

JRQueryExecuter

public class JRCsvQueryExecuter
extends JRAbstractQueryExecuter

CSV query executer implementation.

Author:

Narcis Marcu ([email protected])

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 inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

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

Modifier	Constructor and Description
protected	JRCsvQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parametersMap)
protected	JRCsvQueryExecuter(QueryExecutionContext context, JRDataset dataset, Map<String,? extends JRValueParameter> parametersMap)

Method Summary

Modifier and Type	Method and Description
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 String	getParameterReplacement(String parameterName) Returns the replacement text for a query parameter.

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, getCanonicalQueryLanguage, getCollectedParameterNames, getCollectedParameters, getIntegerParameter, getIntegerParameter, getIntegerParameterOrProperty, getIntegerParameterOrProperty, getJasperReportsContext, getParameter, 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

Constructor Detail

JRCsvQueryExecuter

protected JRCsvQueryExecuter(JasperReportsContext jasperReportsContext,
                             JRDataset dataset,
                             Map<String,? extends JRValueParameter> parametersMap)

JRCsvQueryExecuter

protected JRCsvQueryExecuter(QueryExecutionContext context,
                             JRDataset dataset,
                             Map<String,? extends JRValueParameter> parametersMap)

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