net.sf.jasperreports.engine.JasperExportManager Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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
* This class contains convenience methods for exporting to only these 3 formats.
* These methods can process data that comes from different
* sources and goes to different destinations (files, input and output streams, etc.).
*
* For exporting to XLS and CSV format or for using special exporter parameters,
* the specific exporter class should be used directly.
*
* @see net.sf.jasperreports.engine.JasperPrint
* @see net.sf.jasperreports.engine.export.HtmlExporter
* @see net.sf.jasperreports.pdf.JRPdfExporter
* @see net.sf.jasperreports.engine.export.JRXmlExporter
* @see net.sf.jasperreports.engine.export.ooxml.JRXlsxExporter
* @see net.sf.jasperreports.engine.export.JRCsvExporter
* @author Teodor Danciu ([email protected])
*/
public final class JasperExportManager
{
private static final String EXCEPTION_MESSAGE_KEY_MISSING_EXTENSION_PDF = "extensions.missing.extension.pdf";
private JasperReportsContext jasperReportsContext;
/**
*
*/
private JasperExportManager(JasperReportsContext jasperReportsContext)
{
this.jasperReportsContext = jasperReportsContext;
}
/**
*
*/
private static JasperExportManager getDefaultInstance()
{
return new JasperExportManager(DefaultJasperReportsContext.getInstance());
}
/**
*
*/
public static JasperExportManager getInstance(JasperReportsContext jasperReportsContext)
{
return new JasperExportManager(jasperReportsContext);
}
/**
* Exports the generated report file specified by the parameter into PDF format.
* The resulting PDF file has the same name as the report object inside the source file,
* plus the *.pdf extension and it is located in the same directory as the source file.
*
* @param sourceFileName source file containing the generated report
* @return resulting PDF file name
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public String exportToPdfFile(String sourceFileName) throws JRException
{
File sourceFile = new File(sourceFileName);
/* We need the report name. */
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObject(sourceFile);
File destFile = new File(sourceFile.getParent(), jasperPrint.getName() + ".pdf");
String destFileName = destFile.toString();
exportToPdfFile(jasperPrint, destFileName);
return destFileName;
}
/**
* Exports the generated report file specified by the first parameter into PDF format,
* the result being placed in the second file parameter.
*
* @param sourceFileName source file containing the generated report
* @param destFileName file name to place the PDF content into
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToPdfFile(
String sourceFileName,
String destFileName
) throws JRException
{
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObjectFromFile(sourceFileName);
exportToPdfFile(jasperPrint, destFileName);
}
/**
* Exports the generated report file specified by the first parameter into PDF format,
* the result being placed in the second file parameter.
*
* @param jasperPrint report object to export
* @param destFileName file name to place the PDF content into
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToPdfFile(
JasperPrint jasperPrint,
String destFileName
) throws JRException
{
/* */
Exporter exporter = getPdfExporter();
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleOutputStreamExporterOutput(destFileName));
exporter.exportReport();
}
/**
* Exports the generated report read from the supplied input stream into PDF format and
* writes the results to the output stream specified by the second parameter.
*
* @param inputStream input stream to read the generated report object from
* @param outputStream output stream to write the resulting PDF content to
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToPdfStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObject(inputStream);
exportToPdfStream(jasperPrint, outputStream);
}
/**
* Exports the generated report object received as first parameter into PDF format and
* writes the results to the output stream specified by the second parameter.
*
* @param jasperPrint report object to export
* @param outputStream output stream to write the resulting PDF content to
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToPdfStream(
JasperPrint jasperPrint,
OutputStream outputStream
) throws JRException
{
Exporter exporter = getPdfExporter();
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleOutputStreamExporterOutput(outputStream));
exporter.exportReport();
}
/**
* Exports the generated report object received as parameter into PDF format and
* returns the binary content as a byte array.
*
* @param jasperPrint report object to export
* @return byte array representing the resulting PDF content
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public byte[] exportToPdf(JasperPrint jasperPrint) throws JRException
{
ByteArrayOutputStream baos = new ByteArrayOutputStream();
Exporter exporter = getPdfExporter();
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleOutputStreamExporterOutput(baos));
exporter.exportReport();
return baos.toByteArray();
}
/**
*
*/
private Exporter getPdfExporter()
{
try
{
Class clazz = Class.forName("net.sf.jasperreports.pdf.JRPdfExporter");
Constructor constructor = clazz.getConstructor(JasperReportsContext.class);
return (Exporter)constructor.newInstance(jasperReportsContext);
}
catch (ClassNotFoundException e)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_MISSING_EXTENSION_PDF,
(Object[])null
);
}
catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException | InstantiationException e)
{
throw new JRRuntimeException(e);
}
}
/**
* Exports the generated report file specified by the parameter into XML format.
* The resulting XML file has the same name as the report object inside the source file,
* plus the *.jrpxml extension and it is located in the same directory as the source file.
*
* When exporting to XML format, the images can be either embedded in the XML content
* itself using the Base64 encoder or be referenced as external resources.
* If not embedded, the images are placed as distinct files inside a directory
* having the same name as the XML destination file, plus the "_files" suffix.
*
* @param sourceFileName source file containing the generated report
* @param isEmbeddingImages flag that indicates whether the images should be embedded in the
* XML content itself using the Base64 encoder or be referenced as external resources
* @return XML representation of the generated report
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public String exportToXmlFile(
String sourceFileName,
boolean isEmbeddingImages
) throws JRException
{
File sourceFile = new File(sourceFileName);
/* We need the report name. */
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObject(sourceFile);
File destFile = new File(sourceFile.getParent(), jasperPrint.getName() + ".jrpxml");
String destFileName = destFile.toString();
exportToXmlFile(
jasperPrint,
destFileName,
isEmbeddingImages
);
return destFileName;
}
/**
* Exports the generated report file specified by the first parameter into XML format,
* placing the result into the second file parameter.
*
* If not embedded into the XML content itself using the Base64 encoder,
* the images are placed as distinct files inside a directory having the same name
* as the XML destination file, plus the "_files" suffix.
*
* @param sourceFileName source file containing the generated report
* @param destFileName file name to place the XML representation into
* @param isEmbeddingImages flag that indicates whether the images should be embedded in the
* XML content itself using the Base64 encoder or be referenced as external resources
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToXmlFile(
String sourceFileName,
String destFileName,
boolean isEmbeddingImages
) throws JRException
{
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObjectFromFile(sourceFileName);
exportToXmlFile(
jasperPrint,
destFileName,
isEmbeddingImages
);
}
/**
* Exports the generated report object received as parameter into XML format,
* placing the result into the second file parameter.
*
* If not embedded into the XML content itself using the Base64 encoder,
* the images are placed as distinct files inside a directory having the same name
* as the XML destination file, plus the "_files" suffix.
*
* @param jasperPrint report object to export
* @param destFileName file name to place the XML representation into
* @param isEmbeddingImages flag that indicates whether the images should be embedded in the
* XML content itself using the Base64 encoder or be referenced as external resources
*
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToXmlFile(
JasperPrint jasperPrint,
String destFileName,
boolean isEmbeddingImages
) throws JRException
{
JRXmlExporter exporter = new JRXmlExporter(jasperReportsContext);
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
SimpleXmlExporterOutput xmlOutput = new SimpleXmlExporterOutput(destFileName);
xmlOutput.setEmbeddingImages(isEmbeddingImages);
exporter.setExporterOutput(xmlOutput);
exporter.exportReport();
}
/**
* Exports the generated report object read from the supplied input stream into XML format,
* and writes the result to the output stream specified by the second parameter.
* The images are embedded into the XML content itself using the Base64 encoder.
*
* @param inputStream input stream to read the generated report object from
* @param outputStream output stream to write the resulting XML representation to
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToXmlStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObject(inputStream);
exportToXmlStream(jasperPrint, outputStream);
}
/**
* Exports the generated report object supplied as the first parameter into XML format,
* and writes the result to the output stream specified by the second parameter.
* The images are embedded into the XML content itself using the Base64 encoder.
*
* @param jasperPrint report object to export
* @param outputStream output stream to write the resulting XML representation to
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToXmlStream(
JasperPrint jasperPrint,
OutputStream outputStream
) throws JRException
{
JRXmlExporter exporter = new JRXmlExporter(jasperReportsContext);
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleXmlExporterOutput(outputStream));
exporter.exportReport();
}
/**
* Exports the generated report object supplied as parameter into XML format
* and returs the result as String.
* The images are embedded into the XML content itself using the Base64 encoder.
*
* @param jasperPrint report object to export
* @return XML representation of the generated report
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public String exportToXml(JasperPrint jasperPrint) throws JRException
{
StringBuilder sb = new StringBuilder();
JRXmlExporter exporter = new JRXmlExporter(jasperReportsContext);
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleXmlExporterOutput(sb));
exporter.exportReport();
return sb.toString();
}
/**
* Exports the generated report file specified by the parameter into HTML format.
* The resulting HTML file has the same name as the report object inside the source file,
* plus the *.html extension and it is located in the same directory as the source file.
* The images are placed as distinct files inside a directory having the same name
* as the HTML destination file, plus the "_files" suffix.
*
* @param sourceFileName source file containing the generated report
* @return resulting HTML file name
* @see net.sf.jasperreports.engine.export.HtmlExporter
*/
public String exportToHtmlFile(
String sourceFileName
) throws JRException
{
File sourceFile = new File(sourceFileName);
/* We need the report name. */
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObject(sourceFile);
File destFile = new File(sourceFile.getParent(), jasperPrint.getName() + ".html");
String destFileName = destFile.toString();
exportToHtmlFile(
jasperPrint,
destFileName
);
return destFileName;
}
/**
* Exports the generated report file specified by the first parameter into HTML format,
* placing the result into the second file parameter.
*
* The images are placed as distinct files inside a directory having the same name
* as the HTML destination file, plus the "_files" suffix.
*
* @param sourceFileName source file containing the generated report
* @param destFileName file name to place the HTML content into
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToHtmlFile(
String sourceFileName,
String destFileName
) throws JRException
{
JasperPrint jasperPrint = (JasperPrint)JRLoader.loadObjectFromFile(sourceFileName);
exportToHtmlFile(
jasperPrint,
destFileName
);
}
/**
* Exports the generated report object received as parameter into HTML format,
* placing the result into the second file parameter.
*
* The images are placed as distinct files inside a directory having the same name
* as the HTML destination file, plus the "_files" suffix.
*
* @param jasperPrint report object to export
* @param destFileName file name to place the HTML content into
* @see net.sf.jasperreports.pdf.JRPdfExporter
*/
public void exportToHtmlFile(
JasperPrint jasperPrint,
String destFileName
) throws JRException
{
HtmlExporter exporter = new HtmlExporter(jasperReportsContext);
exporter.setExporterInput(new SimpleExporterInput(jasperPrint));
exporter.setExporterOutput(new SimpleHtmlExporterOutput(destFileName));
exporter.exportReport();
}
/**
* @see #exportToPdfFile(String)
*/
public static String exportReportToPdfFile(String sourceFileName) throws JRException
{
return getDefaultInstance().exportToPdfFile(sourceFileName);
}
/**
* @see #exportToPdfFile(String, String)
*/
public static void exportReportToPdfFile(
String sourceFileName,
String destFileName
) throws JRException
{
getDefaultInstance().exportToPdfFile(sourceFileName, destFileName);
}
/**
* @see #exportToPdfFile(JasperPrint, String)
*/
public static void exportReportToPdfFile(
JasperPrint jasperPrint,
String destFileName
) throws JRException
{
getDefaultInstance().exportToPdfFile(jasperPrint, destFileName);
}
/**
* @see #exportToPdfStream(InputStream, OutputStream)
*/
public static void exportReportToPdfStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().exportToPdfStream(inputStream, outputStream);
}
/**
* Exports the generated report object received as first parameter into PDF format and
* writes the results to the output stream specified by the second parameter.
*
* @param jasperPrint report object to export
* @param outputStream output stream to write the resulting PDF content to
* @see net.sf.jasperreports.pdf.JRPdfExporter
* @see #exportToPdfStream(JasperPrint, OutputStream)
*/
public static void exportReportToPdfStream(
JasperPrint jasperPrint,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().exportToPdfStream(jasperPrint, outputStream);
}
/**
* @see #exportToPdf(JasperPrint)
*/
public static byte[] exportReportToPdf(JasperPrint jasperPrint) throws JRException
{
return getDefaultInstance().exportToPdf(jasperPrint);
}
/**
* @see #exportToXmlFile(String, String, boolean)
*/
public static String exportReportToXmlFile(
String sourceFileName,
boolean isEmbeddingImages
) throws JRException
{
return getDefaultInstance().exportToXmlFile(sourceFileName, isEmbeddingImages);
}
/**
* @see #exportToXmlFile(String, String, boolean)
*/
public static void exportReportToXmlFile(
String sourceFileName,
String destFileName,
boolean isEmbeddingImages
) throws JRException
{
getDefaultInstance().exportToXmlFile(sourceFileName, destFileName, isEmbeddingImages);
}
/**
* @see #exportToXmlFile(JasperPrint, String, boolean)
*/
public static void exportReportToXmlFile(
JasperPrint jasperPrint,
String destFileName,
boolean isEmbeddingImages
) throws JRException
{
getDefaultInstance().exportToXmlFile(jasperPrint, destFileName, isEmbeddingImages);
}
/**
* @see #exportToXmlStream(InputStream, OutputStream)
*/
public static void exportReportToXmlStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().exportToXmlStream(inputStream, outputStream);
}
/**
* @see #exportToXmlStream(JasperPrint, OutputStream)
*/
public static void exportReportToXmlStream(
JasperPrint jasperPrint,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().exportToXmlStream(jasperPrint, outputStream);
}
/**
* @see #exportToXml(JasperPrint)
*/
public static String exportReportToXml(JasperPrint jasperPrint) throws JRException
{
return getDefaultInstance().exportToXml(jasperPrint);
}
/**
* @see #exportToHtmlFile(String)
*/
public static String exportReportToHtmlFile(
String sourceFileName
) throws JRException
{
return getDefaultInstance().exportToHtmlFile(sourceFileName);
}
/**
* @see #exportToHtmlFile(String, String)
*/
public static void exportReportToHtmlFile(
String sourceFileName,
String destFileName
) throws JRException
{
getDefaultInstance().exportToHtmlFile(sourceFileName, destFileName);
}
/**
* @see #exportToHtmlFile(JasperPrint, String)
*/
public static void exportReportToHtmlFile(
JasperPrint jasperPrint,
String destFileName
) throws JRException
{
getDefaultInstance().exportToHtmlFile(jasperPrint, destFileName);
}
}