com.agenarisk.api.model

Class DataSet

java.lang.Object

com.agenarisk.api.model.DataSet

All Implemented Interfaces:

Identifiable<DataSetException>, Storable

public class DataSet
extends Object
implements Identifiable<DataSetException>, Storable

DataSet class represents an equivalent to a Scenario in AgenaRisk Desktop or Scenario in AgenaRisk Java API v1.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	clearAllData() Clears Observations, VariableObservations and CalculationResults data from this DataSet.
void	clearObservation(Node node) Clears an observation from a Node if it exists.
void	clearObservations() Clears all non-variable observations from this DataSet for all Networks and Nodes
void	clearVariableObservation(Node node, String variableName) Clears the VariableObservation of the provided name in this DataSet for the provided Node.
void	clearVariableObservations() Clears all VariableObservations from this DataSet for all Networks and Nodes.
void	clearVariableObservations(Node node) Clears all VariableObservations from this DataSet for the provided Node.
protected static DataSet	createDataSet(Model model, org.json.JSONObject jsonDataSet) Creates a DataSet for the Model from JSON data.
protected static DataSet	createDataSet(Model model, String id) Factory method to create a DataSet and add it to the given Model.
CalculationResult	getCalculationResult(Node node) Returns the CalculationResult for the given Node.
List<CalculationResult>	getCalculationResults() Gets all CalculationResults for all Nodes for this DataSet.
Map<Node,CalculationResult>	getCalculationResults(Network network) Maps nodes to calculation results in the given network in this data set.
protected int	getDataSetIndex() Gets the index of corresponding logic scenario in the underlying logical model structure
String	getId() Gets the ID of this DataSet.
uk.co.agena.minerva.model.scenario.Scenario	getLogicScenario() Deprecated. Will be made module-restricted in the future.
Model	getModel() Returns the Model that this DataSet belongs to.
Observation	getObservation(Node node) Returns a view of the observation for the given node if there is one.
Set<Observation>	getObservations() Returns all observations in this DataSet for all Networks and Nodes.
Set<Observation>	getObservationsAndVariables() Returns all Observations and VariableObservations in this DataSet for all Networks and Nodes.
Set<Observation>	getObservationsAndVariables(Node node) Returns all Observations and VariableObservations in this DataSet for the provided Node.
VariableObservation	getVariableObservation(Node node, String variableName) Returns a view of the VariableObservation for the provided Node and variable name if there is one.
Set<VariableObservation>	getVariableObservations() Returns all VariableObservations in this DataSet for all Networks and Nodes.
Set<VariableObservation>	getVariableObservations(Node node) Returns a view of VariableObservations for the provided Node.
boolean	hasObservation(Node node) Checks whether the Node has an observation set.
boolean	hasVariableObservation(Node node, String variableName) Checks whether the provided variable in the provided node is observed in this DataSet.
void	loadCalculationResult(org.json.JSONObject jsonResult) Loads calculation result data for this DataSet from a given JSON and creates corresponding objects in the underlying logic.
void	setId(String id) Changes the ID of this Network to the provided ID, if the new ID is not already taken.
protected void	setLogicScenario(uk.co.agena.minerva.model.scenario.Scenario logicScenario) Links this Network to an underlying Minerva Network object.
void	setObservation(org.json.JSONObject jsonObservation) Sets observations according to the given JSON.
void	setObservation(Node node, Object value) Sets a hard observation for a Node.
protected void	setObservationConstant(Node node, String constantName, double value) Sets a node constant observation for a Node.
void	setObservationHard(Node node, double value) Sets a hard real observation for a Node.
void	setObservationHard(Node node, int value) Sets a hard integer observation for a Node.
void	setObservationHard(Node node, String state) Sets a hard observation for a Node.
void	setObservationSoft(Node node, Map<String,Double> weights) Sets a soft observation for the node, assigning a given weights to given states.
void	setObservationSoft(Node node, String[] states, Double[] weights) Sets a soft observation for the node, assigning a given weights to given states.
void	setVariableObservation(Node node, String variableName, double value) Sets a value for the provided variable in the provided Node in this DataSet to override its default value
org.json.JSONObject	toJson() Creates a JSONObject representation of this DataSet

Methods inherited from class java.lang.Object

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

Method Detail

createDataSet

protected static DataSet createDataSet(Model model,
                                       String id)

Factory method to create a DataSet and add it to the given Model.
To be used by the Model class.

Parameters:

model - Model to create and add DataSet to

id - unique ID/name of the DataSet

Returns:

created DataSet

createDataSet

protected static DataSet createDataSet(Model model,
                                       org.json.JSONObject jsonDataSet)
                                throws ModelException,
                                       DataSetException

Creates a DataSet for the Model from JSON data.
If a DataSet with the provided ID already exists, it will append a number to that ID to make it unique.
If an observation in DataSet fails to be set, it is ignored and results for that DataSet are not loaded.

Parameters:

model - the model to create a data set in

jsonDataSet - the JSON data

Returns:

created DataSet

Throws:

ModelException - if a DataSet with this ID already exists

DataSetException - if failed to load observations or results data

getLogicScenario

public final uk.co.agena.minerva.model.scenario.Scenario getLogicScenario()

Deprecated. Will be made module-restricted in the future.

Returns the underlying logical ExtendedBN network.

Returns:

the underlying logical ExtendedBN network

setLogicScenario

protected void setLogicScenario(uk.co.agena.minerva.model.scenario.Scenario logicScenario)

Links this Network to an underlying Minerva Network object. Should only be used while wrapping a new Model around the Minerva Model.

Parameters:

logicScenario - the logical scenario

getModel

public final Model getModel()

Returns the Model that this DataSet belongs to.

Returns:

the Model that this DataSet belongs to

getId

public final String getId()

Gets the ID of this DataSet.

Specified by:

getId in interface Identifiable<DataSetException>

Returns:

the ID of this DataSet

setId

public final void setId(String id)
                 throws DataSetException

Changes the ID of this Network to the provided ID, if the new ID is not already taken.
Will lock IDContainer.class while doing so.

Specified by:

setId in interface Identifiable<DataSetException>

Parameters:

id - the new ID

Throws:

DataSetException - if fails to change ID

setObservationHard

public void setObservationHard(Node node,
                               int value)
                        throws DataSetException

Sets a hard integer observation for a Node.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

value - the observation value

Throws:

DataSetException - if any:
∙ Node's Network does not belong to this Model
∙ Value passed is an invalid observation for the given Node

setObservationHard

public void setObservationHard(Node node,
                               double value)
                        throws DataSetException

Sets a hard real observation for a Node.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

value - the observation value

Throws:

DataSetException - if any:
∙ Node's Network does not belong to this Model
∙ Value passed is an invalid observation for the given Node

setObservationHard

public void setObservationHard(Node node,
                               String state)
                        throws DataSetException

Sets a hard observation for a Node.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

state - observed state

Throws:

DataSetException - if any:
∙ Node's Network does not belong to this Model
∙ Value passed is an invalid observation for the given Node

setObservationConstant

protected void setObservationConstant(Node node,
                                      String constantName,
                                      double value)
                               throws DataSetException

Sets a node constant observation for a Node.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

constantName - node constant to observe

value - the constant value

Throws:

DataSetException - if any:
∙ Node's Network does not belong to this Model
∙ Value passed is an invalid observation for the given Node

setObservation

public void setObservation(Node node,
                           Object value)
                    throws DataSetException

Sets a hard observation for a Node.
Any existing observations are removed and replaced with this one.
The type of observation must be:
∙ String for Boolean, Labelled, Ranked and DiscreteReal nodes,
∙ Integer for IntegerInterval
∙ Double for ContinuousInterval

Parameters:

node - the Node to set observation for

value - the observation value

Throws:

DataSetException - if any of the following applies:
∙ Node's Network does not belong to this Model
∙ State does not exist
∙ Value passed is an invalid observation for the given Node

setObservationSoft

public void setObservationSoft(Node node,
                               String[] states,
                               Double[] weights)
                        throws DataSetException

Sets a soft observation for the node, assigning a given weights to given states.
Note that weights will be normalised to sum up to 1.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

states - Array of states

weights - Array of weights

Throws:

DataSetException - if any of the following applies:
∙ Node's Network does not belong to this Model;
∙ Any of the states do not exist
∙ Value passed is an invalid observation for the given Node
∙ Unequal size of arrays

setObservationSoft

public void setObservationSoft(Node node,
                               Map<String,Double> weights)
                        throws DataSetException

Sets a soft observation for the node, assigning a given weights to given states.
Note that weights will be normalised to sum up to 1.
Only the states with some weight must be provided. The rest will be assumed to have zero weight.
Any existing observations are removed and replaced with this one.

Parameters:

node - the Node to set observation for

weights - the map of states and weights

Throws:

DataSetException - if any of the following applies:
∙ Node's Network does not belong to this Model;
∙ Any of the states do not exist
∙ Value passed is an invalid observation for the given Node

setObservation

public void setObservation(org.json.JSONObject jsonObservation)
                    throws DataSetException,
                           org.json.JSONException

Sets observations according to the given JSON.
Any existing observations are removed and replaced with this one.

Parameters:

jsonObservation - JSON with observations

Throws:

DataSetException - if any of the following applies:
∙ Node's Network does not belong to this Model;
∙ Any of the states do not exist
∙ Value passed is an invalid observation for the given Node

org.json.JSONException - if missing or invalid attributes

hasVariableObservation

public boolean hasVariableObservation(Node node,
                                      String variableName)

Checks whether the provided variable in the provided node is observed in this DataSet.

Parameters:

node - the Node to check

variableName - the name of the variable

Returns:

true if the VariableObserved exists in this DataSet

setVariableObservation

public void setVariableObservation(Node node,
                                   String variableName,
                                   double value)
                            throws DataSetException

Sets a value for the provided variable in the provided Node in this DataSet to override its default value

Parameters:

node - the Node with the variable

variableName - the name of the variable

value - the value of the variable to set

Throws:

DataSetException - if setting the value of the variable failed

getVariableObservations

public Set<VariableObservation> getVariableObservations(Node node)

Returns a view of VariableObservations for the provided Node.
Note that this is just a view of the observation and any changes to it will not affect anything beyond this particular view.
To change an observation, use setVariableObservation() method.

Parameters:

node - the observed Node

Returns:

a set of VariableObservations

getVariableObservation

public VariableObservation getVariableObservation(Node node,
                                                  String variableName)

Returns a view of the VariableObservation for the provided Node and variable name if there is one.
Note that this is just a view of the observation and any changes to it will not affect anything beyond this particular view.
To change an observation, use setVariableObservation() method.

Parameters:

node - the observed Node

variableName - the variable name

Returns:

a VariableObservation or null

getVariableObservations

public Set<VariableObservation> getVariableObservations()

Returns all VariableObservations in this DataSet for all Networks and Nodes.

Returns:

a set of VariableObservations

clearVariableObservation

public void clearVariableObservation(Node node,
                                     String variableName)

Clears the VariableObservation of the provided name in this DataSet for the provided Node.

Parameters:

node - the Node with the variable

variableName - the name of the variable

clearVariableObservations

public void clearVariableObservations(Node node)

Clears all VariableObservations from this DataSet for the provided Node.

Parameters:

node - Node to clear VariableObservations from

clearVariableObservations

public void clearVariableObservations()

Clears all VariableObservations from this DataSet for all Networks and Nodes.

clearAllData

public void clearAllData()

Clears Observations, VariableObservations and CalculationResults data from this DataSet.

clearObservation

public void clearObservation(Node node)

Clears an observation from a Node if it exists.

Parameters:

node - the Node to clear the Observation from

clearObservations

public void clearObservations()

Clears all non-variable observations from this DataSet for all Networks and Nodes

hasObservation

public boolean hasObservation(Node node)

Checks whether the Node has an observation set.

Parameters:

node - the Node to check for observations

Returns:

true if there is an observation for the Node in this DataSet

getObservationsAndVariables

public Set<Observation> getObservationsAndVariables(Node node)

Returns all Observations and VariableObservations in this DataSet for the provided Node.

Parameters:

node - the observed Node

Returns:

a set of Observations and VariableObservations

getObservationsAndVariables

public Set<Observation> getObservationsAndVariables()

Returns all Observations and VariableObservations in this DataSet for all Networks and Nodes.

Returns:

a set of Observations and VariableObservations

getObservations

public Set<Observation> getObservations()

Returns all observations in this DataSet for all Networks and Nodes.

Returns:

a Set of all Observations

getObservation

public Observation getObservation(Node node)

Returns a view of the observation for the given node if there is one.
Note that this is just a view of the observation and any changes to it will not affect anything beyond this particular view.
To change an observation, use setObservation() method.

Parameters:

node - the observed Node

Returns:

null if there is no observation or either HardObservation or SoftObservation

getCalculationResult

public CalculationResult getCalculationResult(Node node)

Returns the CalculationResult for the given Node.

Parameters:

node - the Node for which CalculationResult should be returned

Returns:

CalculationResult for the given Node

getCalculationResults

public List<CalculationResult> getCalculationResults()

Gets all CalculationResults for all Nodes for this DataSet.

Returns:

list of all CalculationResults for all Nodes for this DataSet

getCalculationResults

public Map<Node,CalculationResult> getCalculationResults(Network network)

Maps nodes to calculation results in the given network in this data set.

Parameters:

network - Network to get calculation results for

Returns:

map of nodes to results

loadCalculationResult

public void loadCalculationResult(org.json.JSONObject jsonResult)
                           throws DataSetException,
                                  org.json.JSONException

Loads calculation result data for this DataSet from a given JSON and creates corresponding objects in the underlying logic.

Parameters:

jsonResult - CalculationResult in JSON format

Throws:

DataSetException - if any:
∙ node, network or state not found
∙ range lower bound more or equal then upper bound

org.json.JSONException - if JSON data is invalid

getDataSetIndex

protected int getDataSetIndex()

Gets the index of corresponding logic scenario in the underlying logical model structure

Returns:

data set index

toJson

public org.json.JSONObject toJson()

Creates a JSONObject representation of this DataSet

Specified by:

toJson in interface Storable

Returns:

JSONObject equivalent of this DataSet