net.sf.jasperreports.engine.query
Class JRXPathQueryExecuter

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

public class JRXPathQueryExecuter
extends JRAbstractQueryExecuter

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 paramters in the XPath query are replaced by calling String.valueOf(Object) on the parameter value.

Version:
$Id: JRXPathQueryExecuter.java 1538 2006-12-22 17:04:25 +0200 (Fri, 22 Dec 2006) teodord $
Author:
Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary
 
Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
dataset
 
Constructor Summary
JRXPathQueryExecuter(JRDataset dataset, java.util.Map parametersMap)
           
 
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.
 
Methods inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter
getCollectedParameterNames, getParameter, getParameterValue, getQueryString, getValueParameter, parseQuery
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JRXPathQueryExecuter

public JRXPathQueryExecuter(JRDataset dataset,
                            java.util.Map parametersMap)
Method Detail

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

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