Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2016 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 .
*/
package net.sf.jasperreports.engine.query;
import java.util.Locale;
import java.util.Map;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.data.csv.CsvDataAdapterService;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRValueParameter;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.util.Designated;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Query executer factory for CSV file type.
*
* The factory creates {@link net.sf.jasperreports.engine.query.JRCsvQueryExecuter JRCsvQueryExecuter}
* query executers.
*
* @author Narcis Marcu ([email protected])
*/
public class JRCsvQueryExecuterFactory extends AbstractQueryExecuterFactory implements Designated
{
public static final String QUERY_EXECUTER_NAME = "net.sf.jasperreports.query.executer:CSV";
/**
* Built-in parameter/property holding the value of the source for the CSV file.
*
* It can be:
*
*
a resource on the classpath
*
a file from the filesystem, with an absolute or relative path
*
a url
*
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_SOURCE = JRPropertiesUtil.PROPERTY_PREFIX + "csv.source";
/**
* Built-in parameter holding the value of the java.io.InputStream to be used for obtaining the CSV data.
*/
public static final String CSV_INPUT_STREAM = "CSV_INPUT_STREAM";
/**
* Built-in parameter holding the value of the java.net.URL to be used for obtaining the CSV data.
*/
public static final String CSV_URL = "CSV_URL";
/**
* Built-in parameter holding the value of the java.io.File to be used for obtaining the CSV data.
*/
public static final String CSV_FILE = "CSV_FILE";
/**
* Built-in parameter holding the value of the java.io.Reader to be used for obtaining the CSV data.
*/
public static final String CSV_READER = "CSV_READER";
/**
* Built-in parameter/property holding the value of the charset used to encode the CSV stream.
*
* It is meaningful only in combination with
* {@link #CSV_INPUT_STREAM CSV_INPUT_STREAM}, {@link #CSV_URL CSV_URL} or {@link #CSV_FILE CSV_FILE}.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME,
CsvDataAdapterService.SERVICE_DESIGNATION},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_ENCODING = JRPropertiesUtil.PROPERTY_PREFIX + "csv.encoding";
/**
* Built-in parameter/property holding the names of the columns (in a comma-separated list) to be extracted from the CSV 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 CSV columns in the format:
* net.sf.jasperreports.csv.column.names.{arbitrary_name}=value1[, value2, ...]
*/
@Property(
name = "net.sf.jasperreports.csv.column.names.{arbitrary_name}",
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_COLUMN_NAMES = JRPropertiesUtil.PROPERTY_PREFIX + "csv.column.names";
/**
* Built-in parameter holding the value of the columns to be extracted from the CSV 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 #CSV_COLUMN_NAMES CSV_COLUMN_NAMES}.
*/
public static final String CSV_COLUMN_NAMES_ARRAY = "CSV_COLUMN_NAMES_ARRAY";
/**
* Built-in parameter holding the java.util.Locale value of the locale to be used when parsing the CSV data.
*/
public static final String CSV_LOCALE = "CSV_LOCALE";
/**
* Built-in parameter/property holding the java.lang.String code of the locale to be used when parsing the CSV data.
*
* The allowed format is: language[_country[_variant]]
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0,
valueType = Locale.class
)
public static final String CSV_LOCALE_CODE = JRPropertiesUtil.PROPERTY_PREFIX + "csv.locale.code";
/**
* Built-in parameter holding the java.util.TimeZone value of the timezone to be used when parsing the CSV data.
*/
public static final String CSV_TIMEZONE = "CSV_TIMEZONE";
/**
* Built-in parameter/property holding the java.lang.String value of the time zone id to be used when parsing the CSV data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_TIMEZONE_ID = JRPropertiesUtil.PROPERTY_PREFIX + "csv.timezone.id";
/**
* Built-in parameter holding the value of the java.text.DateFormat used to format date columns from the CSV source.
*/
public static final String CSV_DATE_FORMAT = "CSV_DATE_FORMAT";
/**
* Built-in parameter/property holding the value of the date format pattern to be used when parsing the CSV data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_DATE_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "csv.date.pattern";
/**
* Built-in parameter/property holding the value of the field delimiter from the CSV source.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
defaultValue = ",",
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME,
CsvDataAdapterService.SERVICE_DESIGNATION},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_FIELD_DELIMITER = JRPropertiesUtil.PROPERTY_PREFIX + "csv.field.delimiter";
/**
* Built-in parameter holding the value of the java.text.NumberFormat used to format numeric columns from the CSV source.
*/
public static final String CSV_NUMBER_FORMAT = "CSV_NUMBER_FORMAT";
/**
* Built-in parameter/property holding the value of the number format pattern to be used when parsing the CSV data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_NUMBER_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "csv.number.pattern";
/**
* Build-in parameter/property holding the value of the record delimiter from the CSV source
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
defaultValue = "\\n",
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRCsvQueryExecuterFactory.QUERY_EXECUTER_NAME,
CsvDataAdapterService.SERVICE_DESIGNATION},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String CSV_RECORD_DELIMITER = JRPropertiesUtil.PROPERTY_PREFIX + "csv.record.delimiter";
/**
* Built-in parameter/property specifying whether or not the column names should be obtained
* from the first row in the CSV 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 #CSV_COLUMN_NAMES} or {@link #CSV_COLUMN_NAMES_ARRAY}
* would have no effect.
*/
public static final String CSV_USE_FIRST_ROW_AS_HEADER = "CSV_USE_FIRST_ROW_AS_HEADER";
private final static Object[] CSV_BUILTIN_PARAMETERS = {
CSV_SOURCE, "java.lang.String",
CSV_INPUT_STREAM, "java.io.InputStream",
CSV_URL, "java.net.URL",
CSV_FILE, "java.io.File",
CSV_ENCODING, "java.lang.String",
CSV_READER, "java.io.Reader",
CSV_COLUMN_NAMES, "java.lang.String",
CSV_COLUMN_NAMES_ARRAY, "java.lang.String[]",
CSV_DATE_FORMAT, "java.text.DateFormat",
CSV_DATE_PATTERN, "java.lang.String",
CSV_FIELD_DELIMITER, "java.lang.String",
CSV_NUMBER_FORMAT, "java.text.NumberFormat",
CSV_NUMBER_PATTERN, "java.lang.String",
CSV_RECORD_DELIMITER, "java.lang.String",
CSV_USE_FIRST_ROW_AS_HEADER, "java.lang.Boolean",
CSV_LOCALE, "java.util.Locale",
CSV_LOCALE_CODE, "java.lang.String",
CSV_TIMEZONE, "java.util.TimeZone",
CSV_TIMEZONE_ID, "java.lang.String"
};
@Override
public Object[] getBuiltinParameters() {
return CSV_BUILTIN_PARAMETERS;
}
@Override
public JRQueryExecuter createQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parameters
) throws JRException
{
return new JRCsvQueryExecuter(jasperReportsContext, dataset, parameters);
}
@Override
public boolean supportsQueryParameterType(String className) {
return true;
}
@Override
public String getDesignation()
{
return QUERY_EXECUTER_NAME;
}
}