de.cismet.cismap.commons.gui.printing

Class JasperReportDownload

java.lang.Object

java.util.Observable

de.cismet.tools.gui.downloadmanager.AbstractDownload

de.cismet.tools.gui.downloadmanager.AbstractCancellableDownload

de.cismet.cismap.commons.gui.printing.JasperReportDownload

All Implemented Interfaces:

de.cismet.tools.gui.downloadmanager.Download, Comparable, Runnable, org.openide.util.Cancellable

Direct Known Subclasses:

JasperReportCsvDownload, JasperReportExcelDownload

public class JasperReportDownload
extends de.cismet.tools.gui.downloadmanager.AbstractCancellableDownload

JasperReportDownload is a Download which can be immediately added to the DownloadManager and allows it to create the needed datasource and parameters afterwards. This is the advantage over JasperDownload, as the DownloadManager opens immediately. The datasource and parameters are created via the strategy pattern, which is realized with the two interfaces JasperReportParametersGenerator and JasperReportDataSourceGenerator. A concrete class of these interfaces contains the knowledge of creating the datasource or the parameters. These concrete classes are run in the run()-method of JasperReportDownload and therefor create the datasource or parameters after the download itself has been added to the download manager. Another point is that the creation of the JasperPrint is also time-consuming, with this implementation it has to be created in the download, this was not necessary in JasperDownload.

Note 1: the creation of the datasource and the parameters will not run in the EDT.

Note 2: the datasource will be created before the parameters

Version:

$Revision$, $Date$

Author:

DOCUMENT ME!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JasperReportDownload.JasperReportDataSourceGenerator DOCUMENT ME!
static interface	JasperReportDownload.JasperReportParametersGenerator DOCUMENT ME!

Nested classes/interfaces inherited from interface de.cismet.tools.gui.downloadmanager.Download

de.cismet.tools.gui.downloadmanager.Download.State

Field Summary

Fields inherited from class de.cismet.tools.gui.downloadmanager.AbstractDownload

caughtException, directory, downloadFuture, fileToSaveTo, log, started, status, title

Constructor Summary

Constructors

Constructor and Description
JasperReportDownload(net.sf.jasperreports.engine.JasperReport reportResource, JasperReportDownload.JasperReportParametersGenerator parametersGenerator, JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator, String directory, String title, String filename) Creates a new AnotherJasperDownload object.
JasperReportDownload(String reportResourceName, JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator, String directory, String title, String filename) Creates a new AnotherJasperDownload object.
JasperReportDownload(String reportResourceName, JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator, String directory, String title, String filename, String extension) Creates a new JasperReportDownload object.
JasperReportDownload(String reportResourceName, JasperReportDownload.JasperReportParametersGenerator parametersGenerator, JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator, String directory, String title, String filename) Creates a new AnotherJasperDownload object.
JasperReportDownload(String reportResourceName, Map parameters, JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator, String directory, String title, String filename) Creates a new AnotherJasperDownload object.

Method Summary

Modifier and Type	Method and Description
protected void	exportReportFile(net.sf.jasperreports.engine.JasperPrint print, File fileToSaveTo) DOCUMENT ME!
void	run()

Methods inherited from class de.cismet.tools.gui.downloadmanager.AbstractCancellableDownload

cancel

Methods inherited from class de.cismet.tools.gui.downloadmanager.AbstractDownload

compareTo, determineDestinationFile, equals, error, getCaughtException, getDownloadsCompleted, getDownloadsErroneous, getDownloadsTotal, getExceptionPanel, getFileToSaveTo, getStatus, getTitle, hashCode, setParallelDownloads, startDownload, stateChanged, titleChanged

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.cismet.tools.gui.downloadmanager.Download

addObserver, deleteObserver, getProgress

Constructor Detail

JasperReportDownload

public JasperReportDownload(String reportResourceName,
                            JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator,
                            String directory,
                            String title,
                            String filename)

Creates a new AnotherJasperDownload object. This can be used for Reports without parameters.

Parameters:

reportResourceName - report DOCUMENT ME!

dataSourceGenerator - DOCUMENT ME!

directory - DOCUMENT ME!

title - DOCUMENT ME!

filename - DOCUMENT ME!

JasperReportDownload

public JasperReportDownload(String reportResourceName,
                            JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator,
                            String directory,
                            String title,
                            String filename,
                            String extension)

Creates a new JasperReportDownload object.

Parameters:

reportResourceName - DOCUMENT ME!

dataSourceGenerator - DOCUMENT ME!

directory - DOCUMENT ME!

title - DOCUMENT ME!

filename - DOCUMENT ME!

extension - DOCUMENT ME!

JasperReportDownload

public JasperReportDownload(String reportResourceName,
                            Map parameters,
                            JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator,
                            String directory,
                            String title,
                            String filename)

Creates a new AnotherJasperDownload object. Sometimes it is easier/better to generate the parameters before the actual download. E.g. fetching user input from the GUI.

Parameters:

reportResourceName - report DOCUMENT ME!

parameters - DOCUMENT ME!

dataSourceGenerator - DOCUMENT ME!

directory - DOCUMENT ME!

title - DOCUMENT ME!

filename - DOCUMENT ME!

JasperReportDownload

public JasperReportDownload(String reportResourceName,
                            JasperReportDownload.JasperReportParametersGenerator parametersGenerator,
                            JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator,
                            String directory,
                            String title,
                            String filename)

Creates a new AnotherJasperDownload object.

Parameters:

reportResourceName - report DOCUMENT ME!

parametersGenerator - DOCUMENT ME!

dataSourceGenerator - DOCUMENT ME!

directory - DOCUMENT ME!

title - DOCUMENT ME!

filename - DOCUMENT ME!

JasperReportDownload

public JasperReportDownload(net.sf.jasperreports.engine.JasperReport reportResource,
                            JasperReportDownload.JasperReportParametersGenerator parametersGenerator,
                            JasperReportDownload.JasperReportDataSourceGenerator dataSourceGenerator,
                            String directory,
                            String title,
                            String filename)

Creates a new AnotherJasperDownload object.

Parameters:

reportResource - report DOCUMENT ME!

parametersGenerator - DOCUMENT ME!

dataSourceGenerator - DOCUMENT ME!

directory - DOCUMENT ME!

title - DOCUMENT ME!

filename - DOCUMENT ME!

Method Detail

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in class de.cismet.tools.gui.downloadmanager.AbstractDownload

exportReportFile

protected void exportReportFile(net.sf.jasperreports.engine.JasperPrint print,
                                File fileToSaveTo)
                         throws net.sf.jasperreports.engine.JRException

DOCUMENT ME!

Parameters:

print - DOCUMENT ME!

fileToSaveTo - DOCUMENT ME!

Throws:

net.sf.jasperreports.engine.JRException - DOCUMENT ME!