b4j.report

Interface BugzillaReportGenerator

All Known Implementing Classes:

AbstractEmailReport, AbstractFileReport, AbstractReportGenerator, AssigneeTrackingReport, ChangeLogReport, DetailedBugReport, LogReport, ManagementTrackingReport

public interface BugzillaReportGenerator

Interface for a report generator. Generates a report from bug data and writes its results to some place. The place is defined by the implementation of this class.

A report instance is usually created first, then init(Configuration) will be called to give the object a chance to configure itself from some configuration object (usually XML based).

Then, prepareReport() will be called for each separate report this object has to create.

Next, the object will receive each bug to take into account. A report shall collect all necessary information from the bug and forget about the bug itself immediately as potentially thousands of bugs might be queued up.

Finally, closeReport() will be called. This is the place where your implementation should persist its collected data. Some abstract classes are provided to ease the writing of new reports.

Author:

Ralph Schuster

Method Summary

Methods

Modifier and Type	Method and Description
void	closeReport() Closes a report.
String	getMaximumBugzillaVersion() Returns the maximum Bugzilla version this session supports.
String	getMinimumBugzillaVersion() Returns the minimum Bugzilla version this session supports.
void	init(org.apache.commons.configuration.Configuration config) Configures the report.
void	prepareReport() Prepares a new report.
void	registerBug(Issue bug) Registers a bug for the report.
void	setBugzillaSession(Session bugzillaSession) Sets the current Session object used.

Method Detail

init

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

Configures the report.

Parameters:

config - - the configuration object

Throws:

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

setBugzillaSession

void setBugzillaSession(Session bugzillaSession)

Sets the current Session object used. Implementations can use this session object to retrieve more data out of Bugzilla if the need to do so.

Parameters:

bugzillaSession - - the current session object

getMinimumBugzillaVersion

String getMinimumBugzillaVersion()

Returns the minimum Bugzilla version this session supports. Can return null if no lower limits must be enforced.

Returns:

minimum version of supported Bugzilla version or null

getMaximumBugzillaVersion

String getMaximumBugzillaVersion()

Returns the maximum Bugzilla version this session supports. Can return null if no upper limits must be enforced.

Returns:

maximum version of supported Bugzilla version or null

prepareReport

void prepareReport()

Prepares a new report. This will be called when a new report must be generated.

registerBug

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

closeReport

void closeReport()

Closes a report. Implementations should persist its collected data or results here.