com.agenarisk.api.model

Class Observation

java.lang.Object

com.agenarisk.api.model.Observation

All Implemented Interfaces:

Storable

Direct Known Subclasses:

VariableObservation

public class Observation
extends Object
implements Storable

Observation class is a view of an observation, valid at the time of resolution and not maintained.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Observation(uk.co.agena.minerva.model.scenario.Observation logicObservation, DataSet dataSet, Node node) Constructor for the observation.

Method Summary

Modifier and Type	Method and Description
DataSet	getDataSet() Returns DataSet that contains this Observation.
Map<Object,Double>	getEntries() Returns a map of observation entries.
uk.co.agena.minerva.model.scenario.Observation	getLogicObservation() Getter for the logic observation associated with this Observation.
Node	getNode() Returns the observed Node.
org.json.JSONObject	toJson() Creates a JSONObject representation of this Observation.
String	toString() Returns a JSON String representing this Observation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Observation

protected Observation(uk.co.agena.minerva.model.scenario.Observation logicObservation,
                      DataSet dataSet,
                      Node node)
               throws ObservationException

Constructor for the observation.

Parameters:

logicObservation - Logic observation associated with this Observation

dataSet - DataSet that contains this Observation

node - observed Node

Throws:

ObservationException - entries are empty or not provided

Method Detail

getEntries

public Map<Object,Double> getEntries()

Returns a map of observation entries. Changes to the map are not tracked and have no effect on the model or dataset.

Returns:

map of observation entries

getDataSet

public DataSet getDataSet()

Returns DataSet that contains this Observation.

Returns:

DataSet that contains this Observation

getNode

public Node getNode()

Returns the observed Node.

Returns:

the observed Node

getLogicObservation

public uk.co.agena.minerva.model.scenario.Observation getLogicObservation()

Getter for the logic observation associated with this Observation.

Returns:

the logic observation associated with this Observation

toString

public String toString()

Returns a JSON String representing this Observation.

Overrides:

toString in class Object

Returns:

JSON String representing this Observation

toJson

public org.json.JSONObject toJson()

Creates a JSONObject representation of this Observation.

Specified by:

toJson in interface Storable

Returns:

JSONObject equivalent of this Observation