java.lang.Object
- net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory
- - net.sf.jasperreports.engine.query.JRXPathQueryExecuterFactory

All Implemented Interfaces:

JRQueryExecuterFactory, QueryExecuterFactory, Designated

Direct Known Subclasses:

JaxenXPathQueryExecuterFactory, XalanXPathQueryExecuterFactory
```
public class JRXPathQueryExecuterFactory
extends AbstractQueryExecuterFactory
implements Designated
```
XPath query executer factory.
The factory creates JRXPathQueryExecuter query executers.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`PARAMETER_XML_DATA_DOCUMENT`	Built-in parameter holding the value of the org.w3c.dom.Document used to run the XPath query.
`static java.lang.String`	`PROPERTY_XML_DATE_PATTERN`	Property holding the value of the date format pattern to be used when parsing the XML data.
`static java.lang.String`	`PROPERTY_XML_NUMBER_PATTERN`	Property holding the value of the number format pattern to be used when parsing the XLS data.
`static java.lang.String`	`QUERY_EXECUTER_NAME`
`static java.lang.String`	`XML_DATE_PATTERN`	Parameter holding the format pattern used to instantiate java.util.Date instances.
`static java.lang.String`	`XML_FILE`	Built-in parameter holding the value of the `java.io.File` to be used for obtaining the XML data.
`static java.lang.String`	`XML_INPUT_STREAM`	Built-in parameter holding the value of the `java.io.InputStream` to be used for obtaining the XML data.
`static java.lang.String`	`XML_LOCALE`	Parameter holding the value of the datasource Locale
`static java.lang.String`	`XML_NUMBER_PATTERN`	Parameter holding the format pattern used to instantiate java.lang.Number instances.
`static java.lang.String`	`XML_SOURCE`	Built-in parameter/property holding the value of the `java.lang.String` source to be used for obtaining the XML data.
`static java.lang.String`	`XML_TIME_ZONE`	Parameter holding the value of the datasource Timezone

Fields inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory
QUERY_EXECUTER_FACTORY_PREFIX

Constructor Summary

Constructors
Constructor Description

JRXPathQueryExecuterFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JRQueryExecuter`	`createQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parameters)`	Creates a query executer.
`JRQueryExecuter`	`createQueryExecuter(QueryExecutionContext context, JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parameters)`
`java.lang.Object[]`	`getBuiltinParameters()`	Returns the built-in parameters associated with this query type.
`java.lang.String`	`getDesignation()`
`boolean`	`supportsQueryParameterType(java.lang.String className)`	Decides whether the query executers created by this factory support a query parameter type.

Methods inherited from class net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory
createQueryExecuter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - QUERY_EXECUTER_NAME
```
public static final java.lang.String QUERY_EXECUTER_NAME
```
    See Also:
    
    Constant Field Values
  - PARAMETER_XML_DATA_DOCUMENT
```
public static final java.lang.String PARAMETER_XML_DATA_DOCUMENT
```
    Built-in parameter holding the value of the org.w3c.dom.Document used to run the XPath query.
    
    See Also:
    
    Constant Field Values
  - XML_INPUT_STREAM
```
public static final java.lang.String XML_INPUT_STREAM
```
    Built-in parameter holding the value of the java.io.InputStream to be used for obtaining the XML data.
    
    See Also:
    
    Constant Field Values
  - XML_FILE
```
public static final java.lang.String XML_FILE
```
    Built-in parameter holding the value of the java.io.File to be used for obtaining the XML data.
    
    See Also:
    
    Constant Field Values
  - XML_SOURCE
```
public static final java.lang.String XML_SOURCE
```
    Built-in parameter/property holding the value of the java.lang.String source to be used for obtaining the XML data.
    
    See Also:
    
    Constant Field Values
  - XML_DATE_PATTERN
```
public static final java.lang.String XML_DATE_PATTERN
```
    Parameter holding the format pattern used to instantiate java.util.Date instances.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_XML_DATE_PATTERN
```
public static final java.lang.String PROPERTY_XML_DATE_PATTERN
```
    Property holding the value of the date format pattern to be used when parsing the XML data.
    
    See Also:
    
    Constant Field Values
  - XML_NUMBER_PATTERN
```
public static final java.lang.String XML_NUMBER_PATTERN
```
    Parameter holding the format pattern used to instantiate java.lang.Number instances.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_XML_NUMBER_PATTERN
```
public static final java.lang.String PROPERTY_XML_NUMBER_PATTERN
```
    Property holding the value of the number format pattern to be used when parsing the XLS data.
    
    See Also:
    
    Constant Field Values
  - XML_LOCALE
```
public static final java.lang.String XML_LOCALE
```
    Parameter holding the value of the datasource Locale
    
    See Also:
    
    Constant Field Values
  - XML_TIME_ZONE
```
public static final java.lang.String XML_TIME_ZONE
```
    Parameter holding the value of the datasource Timezone
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JRXPathQueryExecuterFactory
```
public JRXPathQueryExecuterFactory()
```
- Method Detail
  - getBuiltinParameters
```
public java.lang.Object[] getBuiltinParameters()
```
    Description copied from interface: QueryExecuterFactory
    
    Returns the built-in parameters associated with this query type.
    These parameters will be created as system-defined parameters for each report/dataset having a query of this type.
    The returned array should contain consecutive pairs of parameter names and parameter classes (e.g. {"Param1", String.class, "Param2", "List.class"}).
    
    Specified by:
    
    getBuiltinParameters in interface JRQueryExecuterFactory
    
    Specified by:
    
    getBuiltinParameters in interface QueryExecuterFactory
    
    Returns:
    
    array of built-in parameter names and types associated with this query type
  - createQueryExecuter
```
public JRQueryExecuter createQueryExecuter(JasperReportsContext jasperReportsContext,
                                           JRDataset dataset,
                                           java.util.Map<java.lang.String,? extends JRValueParameter> parameters)
                                    throws JRException
```
    Description copied from interface: QueryExecuterFactory
    
    Creates a query executer.
    This method is called at fill time for reports/datasets having a query supported by this factory.
    
    Specified by:
    
    createQueryExecuter in interface QueryExecuterFactory
    
    Parameters:
    
    jasperReportsContext - the JasperReportsContext
    
    dataset - the dataset containing the query, fields, etc
    
    parameters - map of value parameters (instances of JRValueParameter) indexed by name
    
    Returns:
    
    a query executer
    
    Throws:
    
    JRException
  - createQueryExecuter
```
public JRQueryExecuter createQueryExecuter(QueryExecutionContext context,
                                           JRDataset dataset,
                                           java.util.Map<java.lang.String,? extends JRValueParameter> parameters)
                                    throws JRException
```
    Specified by:
    
    createQueryExecuter in interface QueryExecuterFactory
    
    Throws:
    
    JRException
  - supportsQueryParameterType
```
public boolean supportsQueryParameterType(java.lang.String className)
```
    Description copied from interface: QueryExecuterFactory
    
    Decides whether the query executers created by this factory support a query parameter type.
    This check is performed for all $P{..} parameters in the query.
    
    Specified by:
    
    supportsQueryParameterType in interface JRQueryExecuterFactory
    
    Specified by:
    
    supportsQueryParameterType in interface QueryExecuterFactory
    
    Parameters:
    
    className - the value class name of the parameter
    
    Returns:
    
    whether the parameter value type is supported
  - getDesignation
```
public java.lang.String getDesignation()
```
    Specified by:
    
    getDesignation in interface Designated

Class JRXPathQueryExecuterFactory

Field Summary

Fields inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory

Constructor Summary

Method Summary

Methods inherited from class net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory

Methods inherited from class java.lang.Object

Field Detail

QUERY_EXECUTER_NAME

PARAMETER_XML_DATA_DOCUMENT

XML_INPUT_STREAM

XML_FILE

XML_SOURCE

XML_DATE_PATTERN

PROPERTY_XML_DATE_PATTERN

XML_NUMBER_PATTERN

PROPERTY_XML_NUMBER_PATTERN

XML_LOCALE

XML_TIME_ZONE

Constructor Detail

JRXPathQueryExecuterFactory

Method Detail

getBuiltinParameters

createQueryExecuter

createQueryExecuter

supportsQueryParameterType

getDesignation