net.sf.jasperreports.engine.query.AbstractXlsQueryExecuterFactory Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see Workbook to be used for obtaining the Excel data.
*/
public static final String XLS_WORKBOOK = "XLS_WORKBOOK";//FIXMEXLS workbook class
/**
* Built-in parameter holding the value of the java.io.InputStream to be used for obtaining the Excel data.
*/
public static final String XLS_INPUT_STREAM = "XLS_INPUT_STREAM";
/**
* Built-in parameter holding the value of the java.io.File to be used for obtaining the Excel data.
*/
public static final String XLS_FILE = "XLS_FILE";
/**
* Built-in parameter/property holding the value of the java.lang.String source to be used for obtaining the Excel data.
*/
public static final String XLS_SOURCE = JRPropertiesUtil.PROPERTY_PREFIX + "xls.source";
/**
* 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, ...]
*/
public static final String XLS_COLUMN_NAMES = JRPropertiesUtil.PROPERTY_PREFIX + "xls.column.names";
/**
* 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, ...]
*/
public static final String XLS_COLUMN_INDEXES = JRPropertiesUtil.PROPERTY_PREFIX + "xls.column.indexes";
/**
* 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 {@link #XLS_COLUMN_NAMES XLS_COLUMN_NAMES}.
*/
public static final String XLS_COLUMN_NAMES_ARRAY = "XLS_COLUMN_NAMES_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 {@link #XLS_COLUMN_INDEXES XLS_COLUMN_INDEXES}.
*/
public static final String XLS_COLUMN_INDEXES_ARRAY = "XLS_COLUMN_INDEXES_ARRAY";
/**
* Built-in parameter holding the java.util.Locale value of the locale to be used when parsing the Excel data.
*/
public static final String XLS_LOCALE = "XLS_LOCALE";
/**
* 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]]
*/
public static final String XLS_LOCALE_CODE = JRPropertiesUtil.PROPERTY_PREFIX + "xls.locale.code";
/**
* Built-in parameter holding the java.util.TimeZone value of the timezone to be used when parsing the Excel data.
*/
public static final String XLS_TIMEZONE = "XLS_TIMEZONE";
/**
* Built-in parameter/property holding the java.lang.String value of the time zone id to be used when parsing the Excel data.
*/
public static final String XLS_TIMEZONE_ID = JRPropertiesUtil.PROPERTY_PREFIX + "xls.timezone.id";
/**
* Built-in parameter holding the value of the java.text.DateFormat used to format date columns from the Excel source.
*/
public static final String XLS_DATE_FORMAT = "XLS_DATE_FORMAT";
/**
* Built-in parameter/property holding the value of the date format pattern to be used when parsing the Excel data.
*/
public static final String XLS_DATE_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "xls.date.pattern";
/**
* Built-in parameter holding the value of the java.text.NumberFormat used to format numeric columns from the Excel source.
*/
public static final String XLS_NUMBER_FORMAT = "XLS_NUMBER_FORMAT";
/**
* Built-in parameter/property holding the value of the number format pattern to be used when parsing the Excel data.
*/
public static final String XLS_NUMBER_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "xls.number.pattern";
/**
* Built-in parameter/property holding the value of the sheet name to be used when parsing the Excel data.
*/
public static final String XLS_SHEET_SELECTION = JRPropertiesUtil.PROPERTY_PREFIX + "xls.sheet.selection";
/**
* 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 {@link #XLS_COLUMN_NAMES} or {@link #XLS_COLUMN_NAMES_ARRAY}
* would have no effect.
*/
public static final String XLS_USE_FIRST_ROW_AS_HEADER = "XLS_USE_FIRST_ROW_AS_HEADER";
}