CsvJasperRender.java

/*
 * Copyright (c) 2002-2020, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.jasper.service.export;

import java.io.ByteArrayOutputStream;

import javax.servlet.http.HttpServletRequest;

import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.export.JRCsvExporter;
import net.sf.jasperreports.export.SimpleCsvExporterConfiguration;
import net.sf.jasperreports.export.SimpleExporterInput;
import net.sf.jasperreports.export.SimpleWriterExporterOutput;

/**
 * This class generate a Jasper report in CSV format
 *
 */
public class CsvJasperRender extends AbstractDefaultJasperRender
{
    private static final String FILE_TYPE = "csv";
    private static final String FIELD_DELIMITER = ";";
    private static final String OUTPUT_ENCODING = "ISO8859_1";

    /**
     * {@inheritDoc }
     */
    @Override
    public String getFileType( )
    {
        return FILE_TYPE;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    protected byte [ ] getData( HttpServletRequest request, fr.paris.lutece.plugins.jasper.business.JasperReport report, JasperPrint jasperPrint )
            throws JRException
    {
        JRCsvExporter exporter = new JRCsvExporter( );
        SimpleCsvExporterConfiguration exporterConfiguration = new SimpleCsvExporterConfiguration( );
        exporterConfiguration.setFieldDelimiter( FIELD_DELIMITER );
        exporter.setConfiguration( exporterConfiguration );
        exporter.setExporterInput( new SimpleExporterInput( jasperPrint ) );
        ByteArrayOutputStream streamReport = new ByteArrayOutputStream( );
        exporter.setExporterOutput( new SimpleWriterExporterOutput( streamReport, OUTPUT_ENCODING ) );

        exporter.exportReport( );

        return streamReport.toByteArray( );
    }
}