com.agenarisk.api.model

Class Settings

java.lang.Object

com.agenarisk.api.model.Settings

All Implemented Interfaces:

Storable

public class Settings
extends Object
implements Storable

This is a class for Model calculation settings.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Settings.Field This is set of fields for input/output to XML and JSON format

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Settings(Model model)

Method Summary

Modifier and Type	Method and Description
void	fromJson(org.json.JSONObject jsonSettings) Applies Model settings from JSON.
double	getConvergence() Gets simulation entropy error convergence threshold.
int	getIterations() Returns maximum number of iterations during model calculation.
int	getSampleSize() Gets ranked node sample size.
double	getTolerance() Gets simulation evidence tolerance percent.
boolean	isDiscretizeTails() Checks whether tails are discretized during simulated calculation.
static void	loadSettings(Model model, org.json.JSONObject jsonSettings) Utility method to load settings from the provided JSON to the provided Model. For any missing fields, current model settings (or defaults) will be used.
static void	loadSettings(uk.co.agena.minerva.model.Model logicModel, org.json.JSONObject jsonSettings) Utility method to load settings from the provided JSON to the provided API1 Model. For any missing fields, current model settings (or defaults) will be used.
void	setConvergence(double convergence) Sets simulation entropy error convergence threshold
void	setDiscretizeTails(boolean discretizeTails) Sets whether tails are discretized during simulated calculation.
void	setIterations(int iterations) Sets maximum number of iterations during model calculation.
void	setSampleSize(int sampleSize) Sets ranked node sample size.
void	setTolerance(double tolerance) Sets simulation evidence tolerance percent.
org.json.JSONObject	toJson() Returns a JSON representation of the Model settings.
static org.json.JSONObject	toJson(uk.co.agena.minerva.model.Model model) Utility method to build a JSON equivalent of settings from the provided API1 model

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

protected Settings(Model model)

Method Detail

loadSettings

public static void loadSettings(Model model,
                                org.json.JSONObject jsonSettings)

Utility method to load settings from the provided JSON to the provided Model.
For any missing fields, current model settings (or defaults) will be used.

Parameters:

model - Model to load settings to

jsonSettings - JSON to load settings from

loadSettings

public static void loadSettings(uk.co.agena.minerva.model.Model logicModel,
                                org.json.JSONObject jsonSettings)

Utility method to load settings from the provided JSON to the provided API1 Model.
For any missing fields, current model settings (or defaults) will be used.

Parameters:

logicModel - API1 Model to load settings to

jsonSettings - JSON to load settings from

toJson

public static org.json.JSONObject toJson(uk.co.agena.minerva.model.Model model)

Utility method to build a JSON equivalent of settings from the provided API1 model

Parameters:

model - API1 model

Returns:

JSON equivalent of the Settings

getIterations

public int getIterations()

Returns maximum number of iterations during model calculation.

Returns:

maximum number of iterations during model calculation

setIterations

public void setIterations(int iterations)

Sets maximum number of iterations during model calculation.

Parameters:

iterations - maximum number of iterations during model calculation

getConvergence

public double getConvergence()

Gets simulation entropy error convergence threshold.

Returns:

simulation entropy error convergence threshold

setConvergence

public void setConvergence(double convergence)

Sets simulation entropy error convergence threshold

Parameters:

convergence - simulation entropy error convergence threshold

getTolerance

public double getTolerance()

Gets simulation evidence tolerance percent.

Returns:

simulation evidence tolerance percent

setTolerance

public void setTolerance(double tolerance)

Sets simulation evidence tolerance percent.

Parameters:

tolerance - simulation evidence tolerance percent

getSampleSize

public int getSampleSize()

Gets ranked node sample size.

Returns:

ranked node sample size

setSampleSize

public void setSampleSize(int sampleSize)

Sets ranked node sample size.

Parameters:

sampleSize - ranked node sample size

isDiscretizeTails

public boolean isDiscretizeTails()

Checks whether tails are discretized during simulated calculation.

Returns:

true if tails are discretized during simulated calculation, false otherwise

setDiscretizeTails

public void setDiscretizeTails(boolean discretizeTails)

Sets whether tails are discretized during simulated calculation.

Parameters:

discretizeTails - whether tails are discretized during simulated calculation

toJson

public org.json.JSONObject toJson()

Returns a JSON representation of the Model settings.

Specified by:

toJson in interface Storable

Returns:

JSONObject equivalent of Model settings

fromJson

public void fromJson(org.json.JSONObject jsonSettings)

Applies Model settings from JSON.

Parameters:

jsonSettings - JSONObject equivalent of Model settings