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

All Implemented Interfaces:

QueryExecuterFactory, Designated

Direct Known Subclasses:

ExcelQueryExecuterFactory, JRXlsxQueryExecuterFactory, XlsQueryExecuterFactory
```
public abstract class AbstractXlsQueryExecuterFactory
extends AbstractQueryExecuterFactory
implements Designated
```
Query executer factory for Excel file type.

Author:

Sanda Zaharia (shertage@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`QUERY_EXECUTER_NAME`
`static String`	`XLS_COLUMN_INDEXES`	Built-in parameter/property holding the value of the column indexes to be extracted from the Excel source.
`static String`	`XLS_COLUMN_INDEXES_ARRAY`	Built-in parameter holding the value of the column indexes to be extracted from the Excel source, as a `java.lang.Integer[]` object.
`static String`	`XLS_COLUMN_NAMES`	Built-in parameter/property holding the value of the columns to be extracted from the Excel source.
`static String`	`XLS_COLUMN_NAMES_ARRAY`	Built-in parameter holding the value of the columns to be extracted from the Excel source, as a `java.lang.String[]` object.
`static String`	`XLS_DATE_FORMAT`	Built-in parameter holding the value of the `java.text.DateFormat` used to format date columns from the Excel source.
`static String`	`XLS_DATE_PATTERN`	Built-in parameter/property holding the value of the date format pattern to be used when parsing the Excel data.
`static String`	`XLS_FILE`	Built-in parameter holding the value of the `java.io.File` to be used for obtaining the Excel data.
`static String`	`XLS_INPUT_STREAM`	Built-in parameter holding the value of the `java.io.InputStream` to be used for obtaining the Excel data.
`static String`	`XLS_LOCALE`	Built-in parameter holding the `java.util.Locale` value of the locale to be used when parsing the Excel data.
`static String`	`XLS_LOCALE_CODE`	Built-in parameter/property holding the `java.lang.String` code of the locale to be used when parsing the Excel data.
`static String`	`XLS_NUMBER_FORMAT`	Built-in parameter holding the value of the `java.text.NumberFormat` used to format numeric columns from the Excel source.
`static String`	`XLS_NUMBER_PATTERN`	Built-in parameter/property holding the value of the number format pattern to be used when parsing the Excel data.
`static String`	`XLS_SHEET_SELECTION`	Built-in parameter/property holding the value of the sheet name to be used when parsing the Excel data.
`static String`	`XLS_SOURCE`	Built-in parameter/property holding the value of the `java.lang.String` source to be used for obtaining the Excel data.
`static String`	`XLS_TIMEZONE`	Built-in parameter holding the `java.util.TimeZone` value of the timezone to be used when parsing the Excel data.
`static String`	`XLS_TIMEZONE_ID`	Built-in parameter/property holding the `java.lang.String` value of the time zone id to be used when parsing the Excel data.
`static String`	`XLS_USE_FIRST_ROW_AS_HEADER`	Built-in parameter/property specifying whether or not the column names should be obtained from the first row in the Excel source.
`static String`	`XLS_WORKBOOK`	Built-in parameter holding the value of the `Workbook` to be used for obtaining the Excel data.
`static String`	`XLSX_COLUMN_INDEXES`	Deprecated. Replaced by `XLS_COLUMN_INDEXES`.
`static String`	`XLSX_COLUMN_INDEXES_ARRAY`	Deprecated. Replaced by `XLS_COLUMN_INDEXES_ARRAY`.
`static String`	`XLSX_COLUMN_NAMES`	Deprecated. Replaced by `XLS_COLUMN_NAMES`.
`static String`	`XLSX_COLUMN_NAMES_ARRAY`	Deprecated. Replaced by `XLS_COLUMN_NAMES_ARRAY`.
`static String`	`XLSX_DATE_FORMAT`	Deprecated. Replaced by `XLS_DATE_FORMAT`.
`static String`	`XLSX_DATE_PATTERN`	Deprecated. Replaced by `XLS_DATE_PATTERN`.
`static String`	`XLSX_FILE`	Deprecated. Replaced by `XLS_FILE`.
`static String`	`XLSX_INPUT_STREAM`	Deprecated. Replaced by `XLS_INPUT_STREAM`.
`static String`	`XLSX_LOCALE`	Deprecated. Replaced by `XLS_LOCALE`.
`static String`	`XLSX_LOCALE_CODE`	Deprecated. Replaced by `XLS_LOCALE_CODE`.
`static String`	`XLSX_NUMBER_FORMAT`	Deprecated. Replaced by `XLS_NUMBER_FORMAT`.
`static String`	`XLSX_NUMBER_PATTERN`	Deprecated. Replaced by `XLS_NUMBER_PATTERN`.
`static String`	`XLSX_SOURCE`	Deprecated. Replaced by `XLS_SOURCE`.
`static String`	`XLSX_TIMEZONE`	Deprecated. Replaced by `XLS_TIMEZONE`.
`static String`	`XLSX_TIMEZONE_ID`	Deprecated. Replaced by `XLS_TIMEZONE_ID`.
`static String`	`XLSX_USE_FIRST_ROW_AS_HEADER`	Deprecated. Replaced by `XLS_USE_FIRST_ROW_AS_HEADER`.
`static String`	`XLSX_WORKBOOK`	Deprecated. Replaced by `XLS_WORKBOOK`.

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

Constructor Summary

Constructors
Constructor Description

AbstractXlsQueryExecuterFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getDesignation()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface net.sf.jasperreports.engine.query.QueryExecuterFactory
  createQueryExecuter, createQueryExecuter, getBuiltinParameters, supportsQueryParameterType

- Field Detail
  - QUERY_EXECUTER_NAME
```
public static final String QUERY_EXECUTER_NAME
```
    See Also:
    
    Constant Field Values
  - XLS_WORKBOOK
```
public static final String XLS_WORKBOOK
```
    Built-in parameter holding the value of the Workbook to be used for obtaining the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_INPUT_STREAM
```
public static final String XLS_INPUT_STREAM
```
    Built-in parameter holding the value of the java.io.InputStream to be used for obtaining the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_FILE
```
public static final String XLS_FILE
```
    Built-in parameter holding the value of the java.io.File to be used for obtaining the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_SOURCE
```
public static final String XLS_SOURCE
```
    Built-in parameter/property holding the value of the java.lang.String source to be used for obtaining the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_COLUMN_NAMES
```
public static final String XLS_COLUMN_NAMES
```
    Built-in parameter/property holding the value of the columns to be extracted from the Excel source. When used as report parameter, the value has to be a java.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 Excel columns in the format: net.sf.jasperreports.xls.column.names.{arbitrary_name}=value1[, value2, ...]
    
    See Also:
    
    Constant Field Values
  - XLS_COLUMN_INDEXES
```
public static final String XLS_COLUMN_INDEXES
```
    Built-in parameter/property holding the value of the column indexes to be extracted from the Excel source. When used as report parameter, the value has to be a java.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 Excel column indexes in the format: net.sf.jasperreports.xls.column.indexes.{arbitrary_name}=value1[, value2, ...]
    
    See Also:
    
    Constant Field Values
  - XLS_COLUMN_NAMES_ARRAY
```
public static final String XLS_COLUMN_NAMES_ARRAY
```
    Built-in parameter holding the value of the columns to be extracted from the Excel source, as a java.lang.String[] object.
    When this parameter is null or missing, its value defaults to the values provided by properties prefixed with XLS_COLUMN_NAMES.
    
    See Also:
    
    Constant Field Values
  - XLS_COLUMN_INDEXES_ARRAY
```
public static final String XLS_COLUMN_INDEXES_ARRAY
```
    Built-in parameter holding the value of the column indexes to be extracted from the Excel source, as a java.lang.Integer[] object.
    When this parameter is null or missing, its value defaults to the values provided by properties prefixed with XLS_COLUMN_INDEXES.
    
    See Also:
    
    Constant Field Values
  - XLS_LOCALE
```
public static final String XLS_LOCALE
```
    Built-in parameter holding the java.util.Locale value of the locale to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_LOCALE_CODE
```
public static final String XLS_LOCALE_CODE
```
    Built-in parameter/property holding the java.lang.String code of the locale to be used when parsing the Excel data.
    The allowed format is: language[_country[_variant]]
    
    See Also:
    
    Constant Field Values
  - XLS_TIMEZONE
```
public static final String XLS_TIMEZONE
```
    Built-in parameter holding the java.util.TimeZone value of the timezone to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_TIMEZONE_ID
```
public static final String XLS_TIMEZONE_ID
```
    Built-in parameter/property holding the java.lang.String value of the time zone id to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_DATE_FORMAT
```
public static final String XLS_DATE_FORMAT
```
    Built-in parameter holding the value of the java.text.DateFormat used to format date columns from the Excel source.
    
    See Also:
    
    Constant Field Values
  - XLS_DATE_PATTERN
```
public static final String XLS_DATE_PATTERN
```
    Built-in parameter/property holding the value of the date format pattern to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_NUMBER_FORMAT
```
public static final String XLS_NUMBER_FORMAT
```
    Built-in parameter holding the value of the java.text.NumberFormat used to format numeric columns from the Excel source.
    
    See Also:
    
    Constant Field Values
  - XLS_NUMBER_PATTERN
```
public static final String XLS_NUMBER_PATTERN
```
    Built-in parameter/property holding the value of the number format pattern to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_SHEET_SELECTION
```
public static final String XLS_SHEET_SELECTION
```
    Built-in parameter/property holding the value of the sheet name to be used when parsing the Excel data.
    
    See Also:
    
    Constant Field Values
  - XLS_USE_FIRST_ROW_AS_HEADER
```
public static final String XLS_USE_FIRST_ROW_AS_HEADER
```
    Built-in parameter/property specifying whether or not the column names should be obtained from the first row in the Excel source. As parameter, it should hold a java.lang.Boolean value, while as custom dataset property, it should be true or false. If this parameter is set to true, then setting the XLS_COLUMN_NAMES or XLS_COLUMN_NAMES_ARRAY would have no effect.
    
    See Also:
    
    Constant Field Values
  - XLSX_WORKBOOK
```
public static final String XLSX_WORKBOOK
```
    Deprecated.
    Replaced by XLS_WORKBOOK.
    
    Built-in parameter holding the value of the org.apache.poi.ss.usermodel.Workbook to be used for obtaining the XLSX data.
    
    See Also:
    
    Constant Field Values
  - XLSX_INPUT_STREAM
```
public static final String XLSX_INPUT_STREAM
```
    Deprecated.
    Replaced by XLS_INPUT_STREAM.
    
    Built-in parameter holding the value of the java.io.InputStream to be used for obtaining the XLSX data.
    
    See Also:
    
    Constant Field Values
  - XLSX_FILE
```
public static final String XLSX_FILE
```
    Deprecated.
    Replaced by XLS_FILE.
    
    Built-in parameter holding the value of the java.io.File to be used for obtaining the XLSX data.
    
    See Also:
    
    Constant Field Values
  - XLSX_SOURCE
```
public static final String XLSX_SOURCE
```
    Deprecated.
    Replaced by XLS_SOURCE.
    
    Built-in parameter holding the value of the java.lang.String source to be used for obtaining the XLSX data.
    
    See Also:
    
    Constant Field Values
  - XLSX_COLUMN_NAMES
```
public static final String XLSX_COLUMN_NAMES
```
    Deprecated.
    Replaced by 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 a java.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 String XLSX_COLUMN_INDEXES
```
    Deprecated.
    Replaced by 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 a java.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 String XLSX_COLUMN_NAMES_ARRAY
```
    Deprecated.
    Replaced by XLS_COLUMN_NAMES_ARRAY.
    
    Built-in parameter holding the value of the columns to be extracted from the XLSX source, as a java.lang.String[] object.
    When this parameter is null or missing, its value defaults to the values provided by properties prefixed with XLSX_COLUMN_NAMES.
    
    See Also:
    
    Constant Field Values
  - XLSX_COLUMN_INDEXES_ARRAY
```
public static final String XLSX_COLUMN_INDEXES_ARRAY
```
    Deprecated.
    Replaced by XLS_COLUMN_INDEXES_ARRAY.
    
    Built-in parameter holding the value of the column indexes to be extracted from the XLSX source, as a java.lang.Integer[] object.
    When this parameter is null or missing, its value defaults to the values provided by properties prefixed with XLSX_COLUMN_INDEXES.
    
    See Also:
    
    Constant Field Values
  - XLSX_LOCALE
```
public static final String XLSX_LOCALE
```
    Deprecated.
    Replaced by XLS_LOCALE.
    
    Built-in parameter holding the java.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 String XLSX_LOCALE_CODE
```
    Deprecated.
    Replaced by XLS_LOCALE_CODE.
    
    Built-in parameter/property holding the java.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 String XLSX_TIMEZONE
```
    Deprecated.
    Replaced by XLS_TIMEZONE.
    
    Built-in parameter holding the java.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 String XLSX_TIMEZONE_ID
```
    Deprecated.
    Replaced by XLS_TIMEZONE_ID.
    
    Built-in parameter/property holding the java.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 String XLSX_DATE_FORMAT
```
    Deprecated.
    Replaced by XLS_DATE_FORMAT.
    
    Built-in parameter holding the value of the java.text.DateFormat used to format date columns from the XLSX source.
    
    See Also:
    
    Constant Field Values
  - XLSX_DATE_PATTERN
```
public static final String XLSX_DATE_PATTERN
```
    Deprecated.
    Replaced by 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 String XLSX_NUMBER_FORMAT
```
    Deprecated.
    Replaced by XLS_NUMBER_FORMAT.
    
    Built-in parameter holding the value of the java.text.NumberFormat used to format numeric columns from the XLSX source.
    
    See Also:
    
    Constant Field Values
  - XLSX_NUMBER_PATTERN
```
public static final String XLSX_NUMBER_PATTERN
```
    Deprecated.
    Replaced by 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 String XLSX_USE_FIRST_ROW_AS_HEADER
```
    Deprecated.
    Replaced by XLS_USE_FIRST_ROW_AS_HEADER.
    
    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 a java.lang.Boolean value, while as custom dataset property, it should be true or false. If this parameter is set to true, then setting the XLSX_COLUMN_NAMES or XLSX_COLUMN_NAMES_ARRAY would have no effect.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractXlsQueryExecuterFactory
```
public AbstractXlsQueryExecuterFactory()
```
- Method Detail
  - getDesignation
```
public String getDesignation()
```
    Specified by:
    
    getDesignation in interface Designated

Class AbstractXlsQueryExecuterFactory

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_EXECUTER_NAME

XLS_WORKBOOK

XLS_INPUT_STREAM

XLS_FILE

XLS_SOURCE

XLS_COLUMN_NAMES

XLS_COLUMN_INDEXES

XLS_COLUMN_NAMES_ARRAY

XLS_COLUMN_INDEXES_ARRAY

XLS_LOCALE

XLS_LOCALE_CODE

XLS_TIMEZONE

XLS_TIMEZONE_ID

XLS_DATE_FORMAT

XLS_DATE_PATTERN

XLS_NUMBER_FORMAT

XLS_NUMBER_PATTERN

XLS_SHEET_SELECTION

XLS_USE_FIRST_ROW_AS_HEADER

XLSX_WORKBOOK

XLSX_INPUT_STREAM

XLSX_FILE

XLSX_SOURCE

XLSX_COLUMN_NAMES

XLSX_COLUMN_INDEXES

XLSX_COLUMN_NAMES_ARRAY

XLSX_COLUMN_INDEXES_ARRAY

XLSX_LOCALE

XLSX_LOCALE_CODE

XLSX_TIMEZONE

XLSX_TIMEZONE_ID

XLSX_DATE_FORMAT

XLSX_DATE_PATTERN

XLSX_NUMBER_FORMAT

XLSX_NUMBER_PATTERN

XLSX_USE_FIRST_ROW_AS_HEADER

Constructor Detail

AbstractXlsQueryExecuterFactory

Method Detail

getDesignation