org.kepler.reporting.rio.fop

Class ReportRenderer

java.lang.Object

org.kepler.reporting.rio.fop.ReportRenderer

public class ReportRenderer
extends java.lang.Object

This class converts a report object to XML, PDF, and AWT using JAXP (XSLT) and FOP (XSL:FO).

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
ReportRenderer()

Method Summary

Modifier and Type	Method and Description
static java.awt.Component	convertReport2AWT(ReportInstance report, java.io.InputStream xslt) Used for embedding a viewer pane in swing applications
static void	convertReport2FO(ReportInstance report, java.io.File xslt, java.io.File fo)
static void	convertReport2HTML(ReportInstance report, java.io.File xslt, java.io.File html) Converts a Report object to a PDF file.
static void	convertReport2PDF(ReportInstance report, java.io.File pdf, java.io.InputStream xsltStream) Converts a Report object to a PDF file.
static void	convertReport2XML(ReportLayout report, java.io.File xml)
static void	convertReport2XML(ReportLayout report, java.io.OutputStream xml) Converts a Report object to XML.
static void	convertXML2FO(java.io.File xml, java.io.File xslt, java.io.File fo) Converts an XML file to an XSL-FO file using JAXP (XSLT).
static ReportLayout	convertXML2Report(java.io.File xml)
static ReportLayout	convertXML2Report(java.io.InputStream xml)
static void	main(java.lang.String[] args) Main method.
void	renderReportAsAWT(ReportInstance report, java.io.File xslt) Deprecated.
static void	reorderPNGReaders()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.commons.logging.Log log

Constructor Detail

ReportRenderer

public ReportRenderer()

Method Detail

reorderPNGReaders

public static void reorderPNGReaders()

convertReport2PDF

public static void convertReport2PDF(ReportInstance report,
                                     java.io.File pdf,
                                     java.io.InputStream xsltStream)
                              throws java.io.IOException,
                                     org.apache.fop.apps.FOPException,
                                     javax.xml.transform.TransformerException

Converts a Report object to a PDF file.

Parameters:

report - the Report object

pdf - the target PDF file

xsltStream - the stylesheet input stream

Throws:

java.io.IOException - In case of an I/O problem

org.apache.fop.apps.FOPException - In case of a FOP problem

javax.xml.transform.TransformerException - In case of a XSL transformation problem

convertXML2Report

public static ReportLayout convertXML2Report(java.io.File xml)
                                      throws java.io.IOException,
                                             javax.xml.transform.TransformerException

Throws:

java.io.IOException

javax.xml.transform.TransformerException

convertXML2Report

public static ReportLayout convertXML2Report(java.io.InputStream xml)
                                      throws java.io.IOException,
                                             javax.xml.transform.TransformerException

Throws:

java.io.IOException

javax.xml.transform.TransformerException

convertReport2XML

public static void convertReport2XML(ReportLayout report,
                                     java.io.File xml)
                              throws java.io.IOException,
                                     javax.xml.transform.TransformerException

Throws:

java.io.IOException

javax.xml.transform.TransformerException

convertReport2XML

public static void convertReport2XML(ReportLayout report,
                                     java.io.OutputStream xml)
                              throws java.io.IOException,
                                     javax.xml.transform.TransformerException

Converts a Report object to XML.

Parameters:

report - the Report object

xml - the target XML file

Throws:

java.io.IOException - In case of an I/O problem

javax.xml.transform.TransformerException - In case of a XSL transformation problem

convertXML2FO

public static void convertXML2FO(java.io.File xml,
                                 java.io.File xslt,
                                 java.io.File fo)
                          throws java.io.IOException,
                                 javax.xml.transform.TransformerException

Converts an XML file to an XSL-FO file using JAXP (XSLT).

Parameters:

xml - the XML file

xslt - the stylesheet file

fo - the target XSL-FO file

Throws:

java.io.IOException - In case of an I/O problem

javax.xml.transform.TransformerException - In case of a XSL transformation problem

convertReport2FO

public static void convertReport2FO(ReportInstance report,
                                    java.io.File xslt,
                                    java.io.File fo)
                             throws java.io.IOException,
                                    javax.xml.transform.TransformerException

Throws:

java.io.IOException

javax.xml.transform.TransformerException

renderReportAsAWT

public void renderReportAsAWT(ReportInstance report,
                              java.io.File xslt)
                       throws java.io.IOException,
                              org.apache.fop.apps.FOPException,
                              javax.xml.transform.TransformerException

Deprecated.

Renders the Report object in the default FOP viewer. Not intended to be embedded.

Parameters:

report - Report to render

xslt - the transform to use for rendering the Report

Throws:

java.io.IOException

org.apache.fop.apps.FOPException

javax.xml.transform.TransformerException

See Also:

for an embedded soltion.

convertReport2AWT

public static java.awt.Component convertReport2AWT(ReportInstance report,
                                                   java.io.InputStream xslt)
                                            throws java.io.IOException,
                                                   org.apache.fop.apps.FOPException,
                                                   javax.xml.transform.TransformerException

Used for embedding a viewer pane in swing applications

Parameters:

report - Report to render

xslt - transform to use for rendering Report

Returns:

PreviewPane component that can be added to any GUI

Throws:

java.io.IOException

org.apache.fop.apps.FOPException

javax.xml.transform.TransformerException

convertReport2HTML

public static void convertReport2HTML(ReportInstance report,
                                      java.io.File xslt,
                                      java.io.File html)
                               throws java.io.IOException,
                                      javax.xml.transform.TransformerException

Converts a Report object to a PDF file.

Parameters:

report - the Report object

xslt - the stylesheet file

html - the target HTML file

Throws:

java.io.IOException - In case of an I/O problem

org.apache.fop.apps.FOPException - In case of a FOP problem

javax.xml.transform.TransformerException - In case of a XSL transformation problem

main

public static void main(java.lang.String[] args)

Main method.

Parameters:

args - command-line arguments