Class JRXlsxQueryExecuterFactory
- java.lang.Object
-
- net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory
-
- net.sf.jasperreports.engine.query.AbstractXlsQueryExecuterFactory
-
- net.sf.jasperreports.engine.query.JRXlsxQueryExecuterFactory
-
- All Implemented Interfaces:
JRQueryExecuterFactory
,QueryExecuterFactory
,Designated
public class JRXlsxQueryExecuterFactory extends AbstractXlsQueryExecuterFactory
Deprecated.Replaced byExcelQueryExecuterFactory
.Query executer factory for XLSX file type. The factory createsJRXlsxQueryExecuter
query executers.- Author:
- Sanda Zaharia (shertage@users.sourceforge.net)
-
-
Field Summary
-
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
-
Fields inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory
QUERY_EXECUTER_FACTORY_PREFIX
-
-
Constructor Summary
Constructors Constructor Description JRXlsxQueryExecuterFactory()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description JRQueryExecuter
createQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parameters)
Deprecated.Creates a query executer.JRQueryExecuter
createQueryExecuter(QueryExecutionContext context, JRDataset dataset, java.util.Map<java.lang.String,? extends JRValueParameter> parameters)
Deprecated.java.lang.Object[]
getBuiltinParameters()
Deprecated.Returns the built-in parameters associated with this query type.boolean
supportsQueryParameterType(java.lang.String className)
Deprecated.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
-
Methods inherited from class net.sf.jasperreports.engine.query.AbstractQueryExecuterFactory
createQueryExecuter
-
-
-
-
Field Detail
-
XLSX_WORKBOOK
public static final java.lang.String XLSX_WORKBOOK
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_WORKBOOK
.Built-in parameter holding the value of theorg.apache.poi.ss.usermodel.Workbook
to be used for obtaining the XLSX data.- See Also:
- Constant Field Values
-
XLSX_INPUT_STREAM
public static final java.lang.String XLSX_INPUT_STREAM
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_INPUT_STREAM
.Built-in parameter holding the value of thejava.io.InputStream
to be used for obtaining the XLSX data.- See Also:
- Constant Field Values
-
XLSX_FILE
public static final java.lang.String XLSX_FILE
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_FILE
.Built-in parameter holding the value of thejava.io.File
to be used for obtaining the XLSX data.- See Also:
- Constant Field Values
-
XLSX_SOURCE
public static final java.lang.String XLSX_SOURCE
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_SOURCE
.Built-in parameter holding the value of thejava.lang.String
source to be used for obtaining the XLSX data.- See Also:
- Constant Field Values
-
XLSX_COLUMN_NAMES
public static final java.lang.String XLSX_COLUMN_NAMES
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_COLUMN_NAMES
.Built-in parameter/property holding the value of the columns to be extracted from the XLSX source. When used as report parameter, the value has to be ajava.lang.String
object containing column names separated by commas. It can also be used as the prefix for custom dataset properties specifying the names of the XLSX columns in the format:net.sf.jasperreports.xlsx.column.names.{arbitrary_name}=value1[, value2, ...]
- See Also:
- Constant Field Values
-
XLSX_COLUMN_INDEXES
public static final java.lang.String XLSX_COLUMN_INDEXES
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_COLUMN_INDEXES
.Built-in parameter/property holding the value of the column indexs to be extracted from the XLSX source. When used as report parameter, the value has to be ajava.lang.String
object containing column indexes separated by comma. It can also be used as the prefix for custom dataset properties specifying the names of the XLSX column indexes in the format:net.sf.jasperreports.xls.column.indexes.{arbitrary_name}=value1[, value2, ...]
- See Also:
- Constant Field Values
-
XLSX_COLUMN_NAMES_ARRAY
public static final java.lang.String XLSX_COLUMN_NAMES_ARRAY
Deprecated.Built-in parameter holding the value of the columns to be extracted from the XLSX source, as ajava.lang.String[]
object. When this parameter is null or missing, its value defaults to the values provided by properties prefixed withXLSX_COLUMN_NAMES
.- See Also:
- Constant Field Values
-
XLSX_COLUMN_INDEXES_ARRAY
public static final java.lang.String XLSX_COLUMN_INDEXES_ARRAY
Deprecated.Built-in parameter holding the value of the column indexes to be extracted from the XLSX source, as ajava.lang.Integer[]
object. When this parameter is null or missing, its value defaults to the values provided by properties prefixed withXLSX_COLUMN_INDEXES
.- See Also:
- Constant Field Values
-
XLSX_LOCALE
public static final java.lang.String XLSX_LOCALE
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_LOCALE
.Built-in parameter holding thejava.util.Locale
value of the locale to be used when parsing the XLSX data.- See Also:
- Constant Field Values
-
XLSX_LOCALE_CODE
public static final java.lang.String XLSX_LOCALE_CODE
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_LOCALE_CODE
.Built-in parameter/property holding thejava.lang.String
code of the locale to be used when parsing the XLSX data. The allowed format is: language[_country[_variant]]- See Also:
- Constant Field Values
-
XLSX_TIMEZONE
public static final java.lang.String XLSX_TIMEZONE
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_TIMEZONE
.Built-in parameter holding thejava.util.TimeZone
value of the timezone to be used when parsing the XLSX data.- See Also:
- Constant Field Values
-
XLSX_TIMEZONE_ID
public static final java.lang.String XLSX_TIMEZONE_ID
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_TIMEZONE_ID
.Built-in parameter/property holding thejava.lang.String
value of the time zone id to be used when parsing the XLSX data.- See Also:
- Constant Field Values
-
XLSX_DATE_FORMAT
public static final java.lang.String XLSX_DATE_FORMAT
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_DATE_FORMAT
.Built-in parameter holding the value of thejava.text.DateFormat
used to format date columns from the XLSX source.- See Also:
- Constant Field Values
-
XLSX_DATE_PATTERN
public static final java.lang.String XLSX_DATE_PATTERN
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_DATE_PATTERN
.Built-in parameter/property holding the value of the date format pattern to be used when parsing the XLSX data.- See Also:
- Constant Field Values
-
XLSX_NUMBER_FORMAT
public static final java.lang.String XLSX_NUMBER_FORMAT
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_NUMBER_FORMAT
.Built-in parameter holding the value of thejava.text.NumberFormat
used to format numeric columns from the XLSX source.- See Also:
- Constant Field Values
-
XLSX_NUMBER_PATTERN
public static final java.lang.String XLSX_NUMBER_PATTERN
Deprecated.Replaced byAbstractXlsQueryExecuterFactory.XLS_NUMBER_PATTERN
.Built-in parameter/property holding the value of the number format pattern to be used when parsing the XLSX data.- See Also:
- Constant Field Values
-
XLSX_USE_FIRST_ROW_AS_HEADER
public static final java.lang.String XLSX_USE_FIRST_ROW_AS_HEADER
Deprecated.Built-in parameter/property specifying whether or not the column names should be obtained from the first row in the XLSX source. As parameter, it should hold ajava.lang.Boolean
value, while as custom dataset property, it should be true or false. If this parameter is set to true, then setting theXLSX_COLUMN_NAMES
orXLSX_COLUMN_NAMES_ARRAY
would have no effect.- See Also:
- Constant Field Values
-
-
Method Detail
-
getBuiltinParameters
public java.lang.Object[] getBuiltinParameters()
Deprecated.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, java.util.Map<java.lang.String,? extends JRValueParameter> parameters) throws JRException
Deprecated.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, java.util.Map<java.lang.String,? extends JRValueParameter> parameters) throws JRException
Deprecated.- Throws:
JRException
-
supportsQueryParameterType
public boolean supportsQueryParameterType(java.lang.String className)
Deprecated.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
-
-