b4j

Class GenerateReports

java.lang.Object

b4j.GenerateReports

All Implemented Interfaces:

Runnable

public class GenerateReports
extends Object
implements Runnable

Main task object that creates a report from Bugzilla. This class represents the main purpose of Bugzilla4Java project. It is configured through a MetaInformation object that delivers the Bugzilla session object to be used, the search parameters that bugs must fulfill in order to be included in a report, and the actual report objects that will create the output.

Users of this class just need to create an instance, feed the appropriate MetaInformation and run it through its Runnable interface.

The implemented main(String[]) method reads information from a given XML file and creates a MetaInformation object out of it.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
GenerateReports() Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static org.apache.commons.cli.Options	getCommandLineOptions() Creates the command line options.
MetaInformation	getMetaInformation() Returns the meta information object for this generator.
boolean	isCloseSessionWhenDone() Returns whether the generator will close the Bugzilla session after all reports were generated.
static void	main(String[] args) Starts the generator from command line.
void	run() Actually runs the report.
void	setCloseSessionWhenDone(boolean closeSessionWhenDone) Controls whether Bugzilla session will be closed after all reports were created.
void	setMetaInformation(MetaInformation metaInformation) Sets the meta information object that this generator shall use.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateReports

public GenerateReports()

Default Constructor.

Method Detail

getMetaInformation

public MetaInformation getMetaInformation()

Returns the meta information object for this generator.

Returns:

the metaInformation

setMetaInformation

public void setMetaInformation(MetaInformation metaInformation)

Sets the meta information object that this generator shall use.

Parameters:

metaInformation - the meta information to set

isCloseSessionWhenDone

public boolean isCloseSessionWhenDone()

Returns whether the generator will close the Bugzilla session after all reports were generated. Default is false.

Returns:

true when session will be closed, false otherwise.

setCloseSessionWhenDone

public void setCloseSessionWhenDone(boolean closeSessionWhenDone)

Controls whether Bugzilla session will be closed after all reports were created. Default is false;

Parameters:

closeSessionWhenDone - - true if session shall be closed, false otherwise.

main

public static void main(String[] args)

Starts the generator from command line. Reads the XML configuration file and starts the generator. The method accepts one argument: -x <xml-config-file>

Parameters:

args - - command line arguments.

getCommandLineOptions

protected static org.apache.commons.cli.Options getCommandLineOptions()

Creates the command line options.

Returns:

CL options object

run

public void run()

Actually runs the report. The method opens the Bugzilla session, performs a search and forwards all found bug records for registering to all reports configured. It then closes the reports and the Bugzilla Session if required (see closeSessionWhenDone.

Specified by:

run in interface Runnable