/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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.
*
* Copyright (c) 2001 - 2009 Object Refinery Ltd, Pentaho Corporation and Contributors.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.modules.output.table.csv;
import java.io.BufferedOutputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import org.pentaho.reporting.engine.classic.core.MasterReport;
import org.pentaho.reporting.engine.classic.core.ReportProcessingException;
import org.pentaho.reporting.engine.classic.core.modules.output.table.base.StreamReportProcessor;
import org.pentaho.reporting.libraries.fonts.encoding.EncodingRegistry;
/**
* Utility class to provide an easy to use default implementation of CSV table exports.
*
* @author Thomas Morgner
*/
public final class CSVReportUtil
{
/**
* DefaultConstructor.
*/
private CSVReportUtil()
{
}
/**
* Saves a report to CSV format.
*
* @param report the report.
* @param outputStream the output stream.
* @param encoding the encoding for the output stream (can be null).
* @throws ReportProcessingException if the report processing failed.
* @throws IOException if an IO related error occured.
*/
public static void createCSV(final MasterReport report,
final OutputStream outputStream,
final String encoding)
throws ReportProcessingException, IOException
{
if (report == null)
{
throw new NullPointerException();
}
if (outputStream == null)
{
throw new NullPointerException();
}
final StreamCSVOutputProcessor target = new StreamCSVOutputProcessor(report.getConfiguration(), outputStream);
if (encoding != null)
{
target.setEncoding(encoding);
}
final StreamReportProcessor reportProcessor = new StreamReportProcessor(report, target);
reportProcessor.processReport();
reportProcessor.close();
outputStream.flush();
}
/**
* Saves a report to CSV format.
*
* @param report the report.
* @param filename target file name.
* @throws ReportProcessingException if the report processing failed.
* @throws IOException if there was an IOerror while processing the report.
*/
public static void createCSV(final MasterReport report, final String filename)
throws ReportProcessingException, IOException
{
createCSV(report, filename, EncodingRegistry.getPlatformDefaultEncoding());
}
/**
* Saves a report to CSV format.
*
* @param report the report.
* @param filename target file name.
* @param encoding the optional encoding that should be used.
* @throws org.pentaho.reporting.engine.classic.core.ReportProcessingException
* if the report processing failed.
* @throws java.io.IOException if there was an IOerror while processing the report.
*/
public static void createCSV(final MasterReport report,
final String filename,
final String encoding)
throws ReportProcessingException, IOException
{
if (report == null)
{
throw new NullPointerException();
}
if (filename == null)
{
throw new NullPointerException();
}
final OutputStream fout = new BufferedOutputStream(new FileOutputStream(filename));
try
{
createCSV(report, fout, encoding);
}
finally
{
fout.close();
}
}
}