ch.elca.dependency.report
Class Report

java.lang.Object
  |
  +--ch.elca.dependency.report.Report

public final class Report

extends java.lang.Object

Report is a façade to the ch.elca.dependency.report package. Use it to create, format and output Reports on a analyzed Project. As the constructor of this class has no public access, use the ReportManager.createReport() method to get an Instance of this class.

Version:

1.0-beta

Author:

Pawel Kowalski

See Also:

ReportManager, ReportHandler, ReportFormatter, ReportInfo, ch.elca.dependency.rawmodel.RawModel, DependencyModel

Constructor Summary

Report()
Creates a new Report instance.

Report(DependencyModel dependencyModel)
Creates a new Report instance ant initializes it with the specified DependencyModel and RawModel.

Method Summary

void	addReportInfo(java.lang.Class reportInfoClass) Add a ReportInfo Object specified by its class to this Report.
void	addReportInfo(java.lang.String reportInfoClassName) Add a ReportInfo Object specified by its fully qualified classname to this Report.
java.lang.String	formatReport() Format this report.
java.lang.String	formatReport(ReportFormatter reportFormatter) Format this report with the specified ReportFormatter.
void	initReport(DependencyModel dependencyModel) Init this Report with a DependencyModel and a RawModel.
void	outputReport() Output this report.
void	outputReport(ch.elca.dependency.report.ReportHandler reportHandler) Output this report with the specified ReportHandler.
void	outputReport(java.lang.String report) Output the specified report.
void	outputReport(java.lang.String report, ch.elca.dependency.report.ReportHandler reportHandler) Output the specified report with the specified ReportHandler.
void	reinitReport() Reinitialize this Report.
void	setOutputFile(java.lang.String filename) Set the filename of the File the Reportt will be written into.
void	setReportFormatter(ReportFormatter reportFormatter) Set ReportFormatter which will be used to format reports.
void	setReportFormatter(java.lang.String reportFormatterClassName) Set ReportFormatter which will be used to format reports (use the ReportFormatter's fully Qualified class name to do so).
void	setReportHandler(ch.elca.dependency.report.ReportHandler reportHandler) Set ReportHandler which will be used to output the formatted Report.
void	setReportHandler(java.lang.String reportHandlerClassName) Set ReportHandler which will be used to output the formatted Report (use to ReportHandler's fully qualified name to do so).

Methods inherited from class java.lang.Object

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

Constructor Detail

Report

public Report()

Creates a new Report instance.

Report

public Report(DependencyModel dependencyModel)

Creates a new Report instance ant initializes it with the specified DependencyModel and RawModel.

Method Detail

initReport

public void initReport(DependencyModel dependencyModel)

Init this Report with a DependencyModel and a RawModel.

reinitReport

public void reinitReport()

Reinitialize this Report.

setReportFormatter

public void setReportFormatter(java.lang.String reportFormatterClassName)
                        throws ReportException

Set ReportFormatter which will be used to format reports (use the ReportFormatter's fully Qualified class name to do so). This method will be used mainly by the jakarta Digester during the construction of this Report.

Parameters:

reportFormatterClassName - a String value

Throws:

ReportException - if an error occurs

setReportFormatter

public void setReportFormatter(ReportFormatter reportFormatter)

Set ReportFormatter which will be used to format reports.

Parameters:

reportFormatter - a ReportFormatter value

setReportHandler

public void setReportHandler(java.lang.String reportHandlerClassName)
                      throws ReportException

Set ReportHandler which will be used to output the formatted Report (use to ReportHandler's fully qualified name to do so). This method will be used mainly by the jakarta Digester during the construction of this Report.

Parameters:

reportHandlerClassName - a String value

Throws:

ReportException - if an error occurs

setReportHandler

public void setReportHandler(ch.elca.dependency.report.ReportHandler reportHandler)

Set ReportHandler which will be used to output the formatted Report.

Parameters:

reportHandler - a ReportHandler value

setOutputFile

public void setOutputFile(java.lang.String filename)

Set the filename of the File the Reportt will be written into.

Parameters:

filename - a String value

formatReport

public java.lang.String formatReport()

Format this report.

Returns:

a String value

formatReport

public java.lang.String formatReport(ReportFormatter reportFormatter)

Format this report with the specified ReportFormatter.

Parameters:

reportFormatter - a ReportFormatter value

Returns:

a String value

outputReport

public void outputReport()
                  throws ReportException

Output this report.

Throws:

ReportException - if an error occurs

outputReport

public void outputReport(ch.elca.dependency.report.ReportHandler reportHandler)
                  throws ReportException

Output this report with the specified ReportHandler.

Parameters:

reportHandler - a ReportHandler value

Throws:

ReportException - if an error occurs

outputReport

public void outputReport(java.lang.String report)
                  throws ReportException

Output the specified report.

Parameters:

report - a String value

Throws:

ReportException - if an error occurs

outputReport

public void outputReport(java.lang.String report,
                         ch.elca.dependency.report.ReportHandler reportHandler)
                  throws ReportException

Output the specified report with the specified ReportHandler.

Parameters:

report - a String value

reportHandler - a ReportHandler value

Throws:

ReportException - if an error occurs

addReportInfo

public void addReportInfo(java.lang.String reportInfoClassName)
                   throws ReportException

Add a ReportInfo Object specified by its fully qualified classname to this Report. This method will be used mainly during the creation of this Report.

Parameters:

reportInfoClassName - a String value

Throws:

ReportException - if an error occurs

addReportInfo

public void addReportInfo(java.lang.Class reportInfoClass)
                   throws ReportException

Add a ReportInfo Object specified by its class to this Report.

Parameters:

reportInfoClass - a Class value

Throws:

ReportException - if an error occurs