net.sf.jasperreports.engine.query

Class JaxenXPathQueryExecuter

java.lang.Object

net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

net.sf.jasperreports.engine.query.JaxenXPathQueryExecuter

All Implemented Interfaces:

JRQueryExecuter

public class JaxenXPathQueryExecuter
extends JRAbstractQueryExecuter

Jaxen XPath query executer implementation.

The XPath query of the report is executed against the document specified by the PARAMETER_XML_DATA_DOCUMENT parameter.

All the parameters in the XPath query are replaced by calling String.valueOf(Object) on the parameter value.

Version:

$Id: JaxenXPathQueryExecuter.java 5576 2012-08-16 09:04:00Z lucianc $

Author:

Narcis Marcu (narcism@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 inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

CLAUSE_POSITION_ID, clauseFunctions, dataset

Constructor Summary

Constructors

Constructor and Description
JaxenXPathQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parametersMap)
JaxenXPathQueryExecuter(JRDataset dataset, Map<String,? extends JRValueParameter> parametersMap) Deprecated. Replaced by JaxenXPathQueryExecuter(JasperReportsContext, JRDataset, Map).

Method Summary

Methods

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	getCanonicalQueryLanguage() Returns a canonical query language for this query executer implementation.
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, getBooleanParameterOrProperty, getCollectedParameterNames, getCollectedParameters, getJasperReportsContext, getParameter, getParameterValue, getParameterValue, getPropertiesUtil, getQueryString, 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

JaxenXPathQueryExecuter

public JaxenXPathQueryExecuter(JasperReportsContext jasperReportsContext,
                       JRDataset dataset,
                       Map<String,? extends JRValueParameter> parametersMap)

JaxenXPathQueryExecuter

public JaxenXPathQueryExecuter(JRDataset dataset,
                       Map<String,? extends JRValueParameter> parametersMap)

Deprecated. Replaced by JaxenXPathQueryExecuter(JasperReportsContext, JRDataset, Map).

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

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

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