Package net.sf.jasperreports.poi.query
Class ExcelQueryExecuterFactory
- java.lang.Object
-
- net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory
-
- net.sf.jasperreports.engine.query.AbstractXlsQueryExecuterFactory
-
- net.sf.jasperreports.poi.query.ExcelQueryExecuterFactory
-
- All Implemented Interfaces:
QueryExecuterFactory
,Designated
public class ExcelQueryExecuterFactory extends AbstractXlsQueryExecuterFactory
Query executer factory for Excel file type. The factory createsExcelQueryExecuter
query executers.- Author:
- Sanda Zaharia (shertage@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
XLS_FORMAT
Built-in parameter/property holding the value of the Excel format to be used when parsing the Excel data.-
Fields inherited from class net.sf.jasperreports.engine.query.AbstractXlsQueryExecuterFactory
QUERY_EXECUTER_NAME, XLS_COLUMN_INDEXES, XLS_COLUMN_INDEXES_ARRAY, XLS_COLUMN_NAMES, XLS_COLUMN_NAMES_ARRAY, XLS_DATE_FORMAT, XLS_DATE_PATTERN, XLS_FILE, XLS_INPUT_STREAM, XLS_LOCALE, XLS_LOCALE_CODE, XLS_NUMBER_FORMAT, XLS_NUMBER_PATTERN, XLS_SHEET_SELECTION, XLS_SOURCE, XLS_TIMEZONE, XLS_TIMEZONE_ID, XLS_USE_FIRST_ROW_AS_HEADER, XLS_WORKBOOK, XLSX_COLUMN_INDEXES, XLSX_COLUMN_INDEXES_ARRAY, XLSX_COLUMN_NAMES, XLSX_COLUMN_NAMES_ARRAY, XLSX_DATE_FORMAT, XLSX_DATE_PATTERN, XLSX_FILE, XLSX_INPUT_STREAM, XLSX_LOCALE, XLSX_LOCALE_CODE, XLSX_NUMBER_FORMAT, XLSX_NUMBER_PATTERN, XLSX_SOURCE, XLSX_TIMEZONE, XLSX_TIMEZONE_ID, XLSX_USE_FIRST_ROW_AS_HEADER, XLSX_WORKBOOK
-
Fields inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory
QUERY_EXECUTER_FACTORY_PREFIX
-
-
Constructor Summary
Constructors Constructor Description ExcelQueryExecuterFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JRQueryExecuter
createQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parameters)
Creates a query executer.JRQueryExecuter
createQueryExecuter(QueryExecutionContext context, JRDataset dataset, Map<String,? extends JRValueParameter> parameters)
Object[]
getBuiltinParameters()
Returns the built-in parameters associated with this query type.boolean
supportsQueryParameterType(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.AbstractXlsQueryExecuterFactory
getDesignation
-
-
-
-
Field Detail
-
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:
- Constant Field Values
-
-
Method Detail
-
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 JasperReportsContextdataset
- the dataset containing the query, fields, etcparameters
- map of value parameters (instances ofJRValueParameter
) 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
-
-