net.sf.jasperreports.export.CsvMetadataReportConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2022 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.export;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.export.JRCsvMetadataExporter;
import net.sf.jasperreports.export.annotations.ExporterParameter;
import net.sf.jasperreports.export.annotations.ExporterProperty;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Interface containing settings used by the metadata based CSV exporter.
*
* @see JRCsvMetadataExporter
*
* @author Teodor Danciu ([email protected])
*/
public interface CsvMetadataReportConfiguration extends CsvReportConfiguration
{
/**
* Property whose value is used as default for the {@link #isWriteHeader()} export configuration setting.
*
* The property itself defaults to false
.
*
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_4_0_0,
valueType = Boolean.class
)
public static final String PROPERTY_WRITE_HEADER = JRPropertiesUtil.PROPERTY_PREFIX + "export.csv.write.header";
/**
* Properties having this prefix contain comma-separated column names and are used as default
* for the {@link #getColumnNames()} export configuration setting.
*
* @see JRPropertiesUtil
*/
@Property(
name = "net.sf.jasperreports.export.csv.column.names.{arbitrary_name}",
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_4_0_0
)
public static final String PROPERTY_COLUMN_NAMES_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "export.csv.column.names";
/**
* Returns a boolean that specifies whether the export header (the column names) should be written or not.
* @see #PROPERTY_WRITE_HEADER
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRCsvMetadataExporterParameter.class,
name="WRITE_HEADER"
)
@ExporterProperty(
value=PROPERTY_WRITE_HEADER,
booleanDefault=false
)
public Boolean isWriteHeader();
/**
* Returns an array of strings representing the comma-separated names of the columns that should be exported.
*
* NOTE: The order of the columns is important and, for accurate results, they should be in the same order as the original columns.
*
* @see #PROPERTY_COLUMN_NAMES_PREFIX
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRCsvMetadataExporterParameter.class,
name="COLUMN_NAMES"
)
@ExporterProperty(PROPERTY_COLUMN_NAMES_PREFIX)
public String[] getColumnNames();
}