b4j.report

Class DetailedBugReport

java.lang.Object

b4j.report.AbstractReportGenerator

b4j.report.AbstractFileReport

b4j.report.DetailedBugReport

All Implemented Interfaces:

BugzillaReportGenerator

public class DetailedBugReport
extends AbstractFileReport

Reports some details about bug records into a file

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
DetailedBugReport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeReport() Just closes the report by sending the report suffix.
void	init(org.apache.commons.configuration.Configuration config) Reads the configuration for the Bug Report.
void	prepareReport() Just opens the report by sending the report prefix.
void	registerBug(Issue bug) Registers a bug for the report.

Methods inherited from class b4j.report.AbstractFileReport

getOutputFile, getOutputStream

Methods inherited from class b4j.report.AbstractReportGenerator

getBugzillaSession, getMaximumBugzillaVersion, getMinimumBugzillaVersion, setBugzillaSession

Methods inherited from class java.lang.Object

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

Constructor Detail

DetailedBugReport

public DetailedBugReport()

Constructor.

Method Detail

init

public void init(org.apache.commons.configuration.Configuration config)
          throws org.apache.commons.configuration.ConfigurationException

Reads the configuration for the Bug Report. The configuration must be XML based and has the following format:

<outputFile>D:/report.txt</outputFile>
<templateFile>D:/template.txt</templateFile>

The template file follows the rules by Typo3 templates.

Specified by:

init in interface BugzillaReportGenerator

Overrides:

init in class AbstractFileReport

Parameters:

config - - the configuration object

Throws:

org.apache.commons.configuration.ConfigurationException - - when a configuration problem occurs

See Also:

AbstractFileReport.init(org.apache.commons.configuration.Configuration)

prepareReport

public void prepareReport()

Just opens the report by sending the report prefix.

Specified by:

prepareReport in interface BugzillaReportGenerator

Overrides:

prepareReport in class AbstractReportGenerator

closeReport

public void closeReport()

Just closes the report by sending the report suffix.

registerBug

public void registerBug(Issue bug)

Registers a bug for the report. Implementations should collect all necessary data from the given bug and forget about it to save memory.

Parameters:

bug - - the bug to collect data from