broadwick.config

Class ConfigValidator

java.lang.Object

broadwick.config.ConfigValidator

public final class ConfigValidator
extends Object

Validator class for configuration files supplied to Broadwick, the framework for epidemiological modelling.

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigValidationErrors	errors
private Project	project

Constructor Summary

Constructors

Constructor and Description
ConfigValidator(Project project) Create an validator instance that is capable of checking the content of a configuration file.

Method Summary

Modifier and Type	Method and Description
private <T> T	createObject(Class<T> clazz, String name) Create an object through reflection, to use this method to create a solver object Solver solverObj = this.createObject(Solver.class, "RungeKutta4");
Project	getValidatedProject() If the project has been validated, i.e.
ConfigValidationErrors	validate() Validate the project.
private void	validateModels() Validate the Models section of the configuration file.

Methods inherited from class java.lang.Object

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

Field Detail

project

private Project project

errors

private ConfigValidationErrors errors

Constructor Detail

ConfigValidator

public ConfigValidator(Project project)

Create an validator instance that is capable of checking the content of a configuration file.

Parameters:

project - the contents of the [read] configuration file. project.

Method Detail

validate

public ConfigValidationErrors validate()

Validate the project.

Returns:

a ConfigValidationErrors object that contains all the errors (if any).

validateModels

private void validateModels()

Validate the Models section of the configuration file. Any errors will be saved in the local ValidationErrors.

getValidatedProject

public Project getValidatedProject()

If the project has been validated, i.e. it is structurally ok, then this method will simply return the project supplied in this objects constructor, else it will return null.

Returns:

null if the project is invalid (i.e. contains major errors) else returns the project object supplied to the constructor.

createObject

private <T> T createObject(Class<T> clazz,
                           String name)

Create an object through reflection, to use this method to create a solver object Solver solverObj = this.createObject(Solver.class, "RungeKutta4");

Type Parameters:

T - the type of object to create.

Parameters:

clazz - the class type of the object we will create.

name - the name of the class that is to be instantiated.

Returns:

the created object.