broadwick

Class Broadwick

java.lang.Object

broadwick.Broadwick

public final class Broadwick
extends Object

Broadwick: Project for Scientific Computing. The Broadwick framework allows for rapid epidemic modelling.

Field Summary

Fields

Modifier and Type	Field and Description
private String	configXml
private org.slf4j.Logger	log
private Project	project

Constructor Summary

Constructors

Constructor and Description
Broadwick(String[] args) Create the Broadwick project to read and verify the configuration files and initialise the project.

Method Summary

Modifier and Type	Method and Description
private NodeList	getAllModelConfigurations() Get a collection of XML elements one for each section.
private String	getModelsConfiguration(String id, NodeList models) Get the XML string of the model with the given id from a list of configured models.
static void	main(String[] args) Invocation point.
private void	readConfigFile(LoggingFacade logFacade, String configFile) Read the configuration file from the configuration file.
private Map<String,Model>	registerModels(Project project, Lookup lookup) Create and register the models internally.
void	run() Run the Broadwick framework.

Methods inherited from class java.lang.Object

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

Field Detail

project

private Project project

log

private org.slf4j.Logger log

configXml

private String configXml

Constructor Detail

Broadwick

public Broadwick(String[] args)

Create the Broadwick project to read and verify the configuration files and initialise the project.

Parameters:

args - the command line arguments supplied to the project.

Method Detail

readConfigFile

private void readConfigFile(LoggingFacade logFacade,
                            String configFile)

Read the configuration file from the configuration file.

Parameters:

logFacade - the LoggingFacade object used to log any messages.

configFile - the name of the configuration file.

run

public void run()

Run the Broadwick framework.

registerModels

private Map<String,Model> registerModels(Project project,
                                         Lookup lookup)

Create and register the models internally. If there was a problem registering the models an empty cache is returned.

Parameters:

project - the unmarshalled configuration file.

lookup - the Lookuup object that allows the model to access the data specified in the data files.

Returns:

the registered models.

getAllModelConfigurations

private NodeList getAllModelConfigurations()
                                    throws ParserConfigurationException,
                                           SAXException,
                                           IOException

Get a collection of XML elements one for each section.

Returns:

a collection of XML elements of each .

Throws:

ParserConfigurationException - if the nodes for the configured models cannot be found.

SAXException - if the nodes for the configured models cannot be found.

IOException - if the nodes for the configured models cannot be found.

getModelsConfiguration

private String getModelsConfiguration(String id,
                                      NodeList models)

Get the XML string of the model with the given id from a list of configured models.

Parameters:

id - the id of the model to be found.

models - a list of XML nodes.

Returns:

the XML string for the model.

main

public static void main(String[] args)

Invocation point.

Parameters:

args - the command line arguments passed to Broadwick.