Package fr.ens.biologie.genomique.aozan

Class QCReportExporter

java.lang.Object

fr.ens.biologie.genomique.aozan.QCReportExporter

public class QCReportExporter
extends Object

This class export the QC Report in several formats.

Since:

3.1

Author:

Laurent Jourdren

Constructor Summary

Constructors

Constructor	Description
QCReportExporter(QCReport qcReport)	Public constructor.

Method Summary

Modifier and Type	Method	Description
String	export(File XSLFile)	Export the QC report.
String	export(InputStream is)	Export the QC report.
String	toXML()	Create the QC report as an XML String.
void	writeRawData(File outputFile)	Write the raw data of the QC.
void	writeRawData(String outputFilename)	Write the raw data of the QC.
void	writeReport(InputStream xslIs, File outputFile)	Write the report usually in HTML) in a file.
void	writeReport(String stylesheetFilename, String outputFilename)	Write the report usually in HTML) in a file.
void	writeXMLReport(File outputFile)	Write the XML in a file.
void	writeXMLReport(String outputFilename)	Write the XML in a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

QCReportExporter

public QCReportExporter(QCReport qcReport)
                 throws AozanException

Public constructor.

Parameters:

qcReport - QC report object

Throws:

AozanException - if an error occurs while getting the XML Document form the QCReport object

Method Detail

writeRawData

public void writeRawData(String outputFilename)
                  throws AozanException

Write the raw data of the QC.

Parameters:

outputFilename - the raw data file

Throws:

AozanException - if an error occurs while writing the file

writeRawData

public void writeRawData(File outputFile)
                  throws AozanException

Write the raw data of the QC.

Parameters:

outputFile - the raw data file

Throws:

AozanException - if an error occurs while writing the file

toXML

public String toXML()
             throws AozanException,
                    IOException

Create the QC report as an XML String.

Returns:

a String with the report in XML

Throws:

AozanException - if an error occurs while creating the report

IOException

writeXMLReport

public void writeXMLReport(String outputFilename)
                    throws AozanException

Write the XML in a file.

Parameters:

outputFilename - the path of the XML file

Throws:

AozanException - if an error occurs while creating the report

writeXMLReport

public void writeXMLReport(File outputFile)
                    throws AozanException

Write the XML in a file.

Parameters:

outputFile - the output file

Throws:

AozanException - if an error occurs while creating the report

export

public String export(File XSLFile)
              throws AozanException

Export the QC report. The XML report is transformed using an XSL style sheet.

Parameters:

XSLFile - XSL file

Returns:

the QC report as a String

Throws:

AozanException - if an error occurs while creating the report

export

public String export(InputStream is)
              throws AozanException

Export the QC report. The XML report is transformed using an XSL style sheet.

Parameters:

is - XSL file as input stream

Returns:

the QC report as a String

Throws:

AozanException - if an error occurs while creating the report

writeReport

public void writeReport(String stylesheetFilename,
                        String outputFilename)
                 throws AozanException

Write the report usually in HTML) in a file.

Parameters:

stylesheetFilename - XSL stylesheet file

outputFilename - the path of the report file

Throws:

AozanException - if an error occurs while creating the report

writeReport

public void writeReport(InputStream xslIs,
                        File outputFile)
                 throws AozanException

Write the report usually in HTML) in a file.

Parameters:

xslIs - XSL stylesheet input stream

outputFile - the report file

Throws:

AozanException - if an error occurs while creating the report