net.sf.dynamicreports.adhoc

Class AdhocManager

java.lang.Object

net.sf.dynamicreports.adhoc.AdhocManager

public class AdhocManager
extends Object

AdhocManager class.

Provides methods for creating JasperReportBuilder given an AdhocReportCustomizer and the AdhocReport itself.

     
      JasperReportBuilder reportBuilder = AdhocManager.createReport(configuration.getReport(), new ReportCustomizer());
     
 

The JasperReportBuilder may also be created using the createReport(AdhocReport) without providing an an implementation for AdhocReportCustomizer relying on the DefaultAdhocReportCustomizer object instead.
The AdhocManager also provides saveConfiguration(AdhocConfiguration, OutputStream) and the loadConfiguration(InputStream) methods for marshalling configuration and unmarshalling configuration to and from the outputStream and inputStream respectively.

Author:

Ricardo Mariaca

Method Summary

Modifier and Type	Method and Description
JasperReportBuilder	createReport(AdhocReport adhocReport) createReport.
JasperReportBuilder	createReport(AdhocReport adhocReport, AdhocReportCustomizer adhocReportCustomizer) createReport.
static AdhocManager	getInstance(IAdhocToXmlTransform adhocToXmlTransform, IXmlToAdhocTransform xmlToAdhocTransform)
AdhocConfiguration	loadConfiguration(InputStream is) loadConfiguration.
void	saveConfiguration(AdhocConfiguration adhocConfiguration, OutputStream os) saveConfiguration.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AdhocManager getInstance(IAdhocToXmlTransform adhocToXmlTransform,
                                       IXmlToAdhocTransform xmlToAdhocTransform)

createReport

public JasperReportBuilder createReport(AdhocReport adhocReport)
                                 throws DRException

createReport.

Creates a JasperReportBuilder which is subsequently set up with the JRDataSource and finaly used to create a report like shown here:

     
     AdhocConfiguration configuration = new AdhocConfiguration();
      AdhocReport report = new AdhocReport();
      configuration.setReport(report);
      // configure report...
     JasperReportBuilder reportBuilder = AdhocManager.createReport(configuration.getReport());
     reportBuilder.setDataSource(createDataSource());
     reportBuilder.show();
     
 

The AdhocReportCustomizer is internally provided by invocation of the DefaultAdhocReportCustomizer

Parameters:

adhocReport - a AdhocReport object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

createReport

public JasperReportBuilder createReport(AdhocReport adhocReport,
                                        AdhocReportCustomizer adhocReportCustomizer)
                                 throws DRException

createReport.

Creates a JasperReportBuilder which is subsequently set up with the JRDataSource and finaly used to create a report like shown here:

     
      AdhocConfiguration configuration = new AdhocConfiguration();
      AdhocReport report = new AdhocReport();
      configuration.setReport(report);
      // configure report...
      JasperReportBuilder reportBuilder = AdhocManager.createReport(configuration.getReport(), new ReportCustomizer());
      reportBuilder.setDataSource(createDataSource());
      reportBuilder.show();
     
 

Parameters:

adhocReport - a AdhocReport object.

adhocReportCustomizer - a AdhocReportCustomizer object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

saveConfiguration

public void saveConfiguration(AdhocConfiguration adhocConfiguration,
                              OutputStream os)
                       throws DRException

saveConfiguration.

This method enables a client to save configuration to an XML file. Consider the folowing example

     AdhocReport report = new AdhocReport();
     AdhocColumn column = new AdhocColumn();
     column.setName("item");
      report.addColumn(column);

      column = new AdhocColumn();
      column.setName("quantity");
      report.addColumn(column);
  AdhocConfiguration configuration = new AdhocConfiguration();
  configuration.setReport(report);

  // Now saving to an XML file in the system
  AdhocManager.saveConfiguration(configuration, new FileOutputStream("c:/temp/configuration.xml"));
 

Parameters:

adhocConfiguration - a AdhocConfiguration object.

os - a OutputStream object.

Throws:

DRException - if any.

loadConfiguration

public AdhocConfiguration loadConfiguration(InputStream is)
                                     throws DRException

loadConfiguration.

This method enables a client to read AdhocConfiguration from an InputStream The method may be applied as shown:

     
        AdhocConfiguration loadedConfiguration = AdhocManager.loadConfiguration(new FileInputStream("c:/temp/configuration.xml"));
     
 

Parameters:

is - a InputStream object.

Returns:

a AdhocConfiguration object.

Throws:

DRException - if any.