net.sf.jasperreports.engine.export.JRCsvExporter 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 - 2019 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 .
*/
/*
* Contributors:
* Mirko Wawrowsky - [email protected]
*/
package net.sf.jasperreports.engine.export;
import java.io.IOException;
import net.sf.jasperreports.engine.DefaultJasperReportsContext;
import net.sf.jasperreports.engine.JRGenericPrintElement;
import net.sf.jasperreports.engine.JRPrintElement;
import net.sf.jasperreports.engine.JRPrintPage;
import net.sf.jasperreports.engine.JRPrintText;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.PrintPageFormat;
import net.sf.jasperreports.engine.util.JRStyledText;
import net.sf.jasperreports.export.CsvExporterConfiguration;
import net.sf.jasperreports.export.CsvReportConfiguration;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Exports a JasperReports document to CSV format. It has character output type and exports the document to a
* grid-based layout.
*
* Because CSV is a data-oriented file format, exporting rich content documents to
* CSV results in a tremendous loss of quality. The CSV exporter will completely ignore graphic elements present in
* the source document that needs to be exported. It will only deal will text elements, and
* from those, it will only extract the text value, completely ignoring the style properties.
*
* CSV is a character-based file format whose content is structured in rows and columns, so
* the {@link net.sf.jasperreports.engine.export.JRCsvExporter} is a grid exporter
* because it must transform the free-form content of
* each page from the source document into a grid-like structure using the special grid layout algorithm.
*
* By default, the CSV exporter uses commas to separate column values and newline
* characters to separate rows in the resulting file. However, one can redefine the delimiters
* using the two special exporter configuration settings in the
* {@link net.sf.jasperreports.export.CsvExporterConfiguration} class:
*
* - {@link net.sf.jasperreports.export.CsvExporterConfiguration#getFieldDelimiter() getFieldDelimiter()}
* - {@link net.sf.jasperreports.export.CsvExporterConfiguration#getRecordDelimiter() getRecordDelimiter()}
*
* which both provide java.lang.String
values.
*
* @see net.sf.jasperreports.export.CsvExporterConfiguration
* @author Teodor Danciu ([email protected])
*/
public class JRCsvExporter extends JRAbstractCsvExporter
{
private static final Log log = LogFactory.getLog(JRCsvExporter.class);
protected class ExporterContext extends BaseExporterContext implements JRCsvExporterContext
{
}
/**
* @see #JRCsvExporter(JasperReportsContext)
*/
public JRCsvExporter()
{
this(DefaultJasperReportsContext.getInstance());
}
/**
*
*/
public JRCsvExporter(JasperReportsContext jasperReportsContext)
{
super(jasperReportsContext);
exporterContext = new ExporterContext();
}
@Override
protected Class getConfigurationInterface()
{
return CsvExporterConfiguration.class;
}
@Override
protected Class getItemConfigurationInterface()
{
return CsvReportConfiguration.class;
}
@Override
@SuppressWarnings("deprecation")
protected void ensureOutput()
{
if (exporterOutput == null)
{
exporterOutput =
new net.sf.jasperreports.export.parameters.ParametersWriterExporterOutput(
getJasperReportsContext(),
getParameters(),
getCurrentJasperPrint()
);
}
}
@Override
protected void exportPage(JRPrintPage page) throws IOException
{
CsvReportConfiguration lcItemConfiguration = getCurrentItemConfiguration();
PrintPageFormat pageFormat = jasperPrint.getPageFormat(pageIndex);
JRGridLayout layout =
new JRGridLayout(
nature,
page.getElements(),
pageFormat.getPageWidth(),
pageFormat.getPageHeight(),
lcItemConfiguration.getOffsetX() == null ? 0 : lcItemConfiguration.getOffsetX(),
lcItemConfiguration.getOffsetY() == null ? 0 : lcItemConfiguration.getOffsetY(),
null //address
);
Grid grid = layout.getGrid();
CutsInfo xCuts = layout.getXCuts();
CutsInfo yCuts = layout.getYCuts();
StringBuilder rowBuilder = null;
boolean isFirstColumn = true;
int rowCount = grid.getRowCount();
for(int y = 0; y < rowCount; y++)
{
Cut yCut = yCuts.getCut(y);
rowBuilder = new StringBuilder();
if (yCut.isCutNotEmpty())
{
isFirstColumn = true;
GridRow row = grid.getRow(y);
int rowSize = row.size();
for(int x = 0; x < rowSize; x++)
{
JRPrintElement element = row.get(x).getElement();
if(element != null)
{
String text = null;
if (element instanceof JRPrintText)
{
JRStyledText styledText = getStyledText((JRPrintText)element);
if (styledText == null)
{
text = "";
}
else
{
text = styledText.getText();
}
}
else if (element instanceof JRGenericPrintElement)
{
JRGenericPrintElement genericPrintElement = (JRGenericPrintElement)element;
GenericElementCsvHandler handler = (GenericElementCsvHandler)
GenericElementHandlerEnviroment.getInstance(getJasperReportsContext()).getElementHandler(
genericPrintElement.getGenericType(), CSV_EXPORTER_KEY);
if (handler == null)
{
if (log.isDebugEnabled())
{
log.debug("No CSV generic element handler for "
+ genericPrintElement.getGenericType());
}
// it shouldn't get to this due to JRCsvExporterNature.isToExport, but let's be safe
text = "";
}
else
{
text = handler.getTextValue(exporterContext, genericPrintElement);
}
}
if (text != null)
{
if (!isFirstColumn)
{
rowBuilder.append(fieldDelimiter);
}
rowBuilder.append(
prepareText(text)
);
isFirstColumn = false;
}
}
else
{
if (xCuts.getCut(x).isCutNotEmpty())
{
if (!isFirstColumn)
{
rowBuilder.append(fieldDelimiter);
}
isFirstColumn = false;
}
}
}
if (rowBuilder.length() > 0)
{
writer.write(rowBuilder.toString());
writer.write(recordDelimiter);
}
}
}
JRExportProgressMonitor progressMonitor = lcItemConfiguration.getProgressMonitor();
if (progressMonitor != null)
{
progressMonitor.afterPageExport();
}
}
}