Class ExcelQueryExecuterFactory

All Implemented Interfaces:
QueryExecuterFactory, Designated

public class ExcelQueryExecuterFactory extends AbstractXlsQueryExecuterFactory
Query executer factory for Excel file type.

The factory creates ExcelQueryExecuter query executers.

Author:
Sanda Zaharia (shertage@users.sourceforge.net)
  • Field Details

    • XLS_FORMAT

      public static final String XLS_FORMAT
      Built-in parameter/property holding the value of the Excel format to be used when parsing the Excel data.
      See Also:
  • Constructor Details

    • ExcelQueryExecuterFactory

      public ExcelQueryExecuterFactory()
  • Method Details

    • getBuiltinParameters

      public 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"}).

      Returns:
      array of built-in parameter names and types associated with this query type
    • createQueryExecuter

      public JRQueryExecuter createQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<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.

      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, Map<String,? extends JRValueParameter> parameters) throws JRException
      Throws:
      JRException
    • supportsQueryParameterType

      public boolean supportsQueryParameterType(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.

      Parameters:
      className - the value class name of the parameter
      Returns:
      whether the parameter value type is supported