JFreeReportBoot (flow-engine JavaDoc)

Class JFreeReportBoot

public class JFreeReportBoot extends AbstractBoot

An utility class to safely boot and initialize the JFreeReport library. This class should be called before using the JFreeReport classes, to make sure that all subsystems are initialized correctly and in the correct order.

Application developers should make sure, that the booting is done, before JFreeReport objects are used. Although the boot process will be started automaticly if needed, this automated start may no longer guarantee the module initialization order.

Additional modules can be specified by defining the system property "org.jfree.report.boot.Modules". The property expects a comma-separated list of org.jfree.base.modules.Module implementations.

Booting should be done by aquirering a new boot instance using getInstance and then starting the boot process with JFreeReportBoot.

Author: Thomas Morgner

Method Summary
ModifiableConfiguration	getEditableConfig() Returns the current global configuration as modifiable instance.
static JFreeReportBoot	getInstance() Returns the singleton instance of the boot utility class.
protected ProjectInformation	getProjectInfo() Returns the project info.
static Configuration	getUserConfig() Returns the user supplied global configuration.
protected Configuration	loadConfiguration() Loads the configuration.
protected void	performBoot() Performs the actual boot process.
static void	setUserConfig(Configuration config) Defines the global user configuration.

Method Summary

ModifiableConfiguration

getEditableConfig()

Returns the current global configuration as modifiable instance.

static JFreeReportBoot

getInstance()

Returns the singleton instance of the boot utility class.

protected ProjectInformation

getProjectInfo()

Returns the project info.

static Configuration

getUserConfig()

Returns the user supplied global configuration.

protected Configuration

loadConfiguration()

Loads the configuration.

protected void

performBoot()

Performs the actual boot process.

static void

setUserConfig(Configuration config)

Defines the global user configuration.

Method Detail

public ModifiableConfiguration getEditableConfig()

Returns the current global configuration as modifiable instance. This is exactly the same as casting the global configuration into a ModifableConfiguration instance.

This is a convinience function, as all programmers are lazy.

Returns: the global config as modifiable configuration.

public static JFreeReportBoot getInstance()

Returns the singleton instance of the boot utility class.

Returns: the boot instance.

protected ProjectInformation getProjectInfo()

Returns the project info.

Returns: The project info.

public static Configuration getUserConfig()

Returns the user supplied global configuration.

Returns: the user configuration, if any.

protected Configuration loadConfiguration()

Loads the configuration. This will be called exactly once.

Returns: The configuration.

protected void performBoot()

Performs the actual boot process.

public static void setUserConfig(Configuration config)

Defines the global user configuration.

Parameters: config the user configuration.