b4j.report

Class AbstractReportGenerator

java.lang.Object

b4j.report.AbstractReportGenerator

All Implemented Interfaces:

BugzillaReportGenerator

Direct Known Subclasses:

AbstractEmailReport, AbstractFileReport, LogReport

public abstract class AbstractReportGenerator
extends Object
implements BugzillaReportGenerator

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
AbstractReportGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected Session	getBugzillaSession() Returns the current Bugzilla session object.
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 file report.
void	prepareReport() Prepares a new report.
void	setBugzillaSession(Session bugzillaSession) Sets the current Session object used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface b4j.report.BugzillaReportGenerator

closeReport, registerBug

Constructor Detail

AbstractReportGenerator

public AbstractReportGenerator()

Method Detail

init

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

Configures the file report. This implementation retrieves the value for "outputFile" or throws an exception when no such element was defined.

Specified by:

init in interface BugzillaReportGenerator

Parameters:

config - - the configuration object

Throws:

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

getMaximumBugzillaVersion

public String getMaximumBugzillaVersion()

Returns the maximum Bugzilla version this session supports. Returns null to indicate that no upper limits must be enforced.

Specified by:

getMaximumBugzillaVersion in interface BugzillaReportGenerator

Returns:

maximum version of supported Bugzilla version or null

getMinimumBugzillaVersion

public String getMinimumBugzillaVersion()

Returns the minimum Bugzilla version this session supports. Returns null to indicate that no lower limits must be enforced.

Specified by:

getMinimumBugzillaVersion in interface BugzillaReportGenerator

Returns:

minimum version of supported Bugzilla version or null

prepareReport

public void prepareReport()

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

Specified by:

prepareReport in interface BugzillaReportGenerator

getBugzillaSession

protected Session getBugzillaSession()

Returns the current Bugzilla session object.

Returns:

the bugzillaSession used for this report.

setBugzillaSession

public 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.

Specified by:

setBugzillaSession in interface BugzillaReportGenerator

Parameters:

bugzillaSession - - the current session object