com.agenarisk.api.model

Class CalculationResult

java.lang.Object

com.agenarisk.api.model.CalculationResult

All Implemented Interfaces:

Storable

public class CalculationResult
extends Object
implements Storable

CalculationResult class represents a view of the Node's calculation results.
It is valid at the time of retrieval and is not maintained.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
protected static CalculationResult	getCalculationResult(DataSet dataset, Node node) Gets a CalculationResult that reflects the status of the underlying logic structure at resolution time.
double	getConfidenceInterval() Gets confidence interval value for this result
DataSet	getDataSet() Returns the DataSet to which the CalculationResult belongs to.
double	getEntropy() Gets entropy error value for this result
uk.co.agena.minerva.model.MarginalDataItem	getLogicCalculationResult() Deprecated. Will be affected by module architecture in the future and should not be used.
double	getLowerPercentile() Gets lower percentile value for this result.
double	getMean() Gets mean value for this result.
double	getMedian() Gets median value for this result.
Node	getNode() Returns the CalculationResult's Node.
double	getPercentile() Gets percentile value for this result.
ResultValue	getResultValue(String label) Returns a specific ResultValue by its label or null.
List<ResultValue>	getResultValues() Returns the Result Values that make up CalculationResult for this Node.
double	getStandardDeviation() Gets standard deviation value for this result.
double	getUpperPercentile() Gets upper percentile value for this result.
double	getVariance() Gets variance value for this result.
boolean	isContinuous() Returns if the calculation result is for a continuous variable.
protected static void	loadCalculationResult(DataSet dataSet, org.json.JSONObject jsonResult) Loads CalculationResult data from JSON into the underlying logic structure.
org.json.JSONObject	toJson() Returns a JSON representation of this object.
String	toString() Returns a String value of the JSON representation of this object.
String	toString(int indentFactor) Returns a String value of the JSON representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

loadCalculationResult

protected static void loadCalculationResult(DataSet dataSet,
                                            org.json.JSONObject jsonResult)
                                     throws DataSetException

Loads CalculationResult data from JSON into the underlying logic structure.
This should typically be used when loading results from file.

Parameters:

dataSet - DataSet to create the CalculationResult in

jsonResult - JSONObject containing data for this CalculationResult

Throws:

DataSetException - if JSON contains invalid data

getCalculationResult

protected static CalculationResult getCalculationResult(DataSet dataset,
                                                        Node node)

Gets a CalculationResult that reflects the status of the underlying logic structure at resolution time.
This should typically be used when the model is calculated.

Parameters:

dataset - DataSet to which the CalculationResult belongs to

node - Node that the CalculationResult is associated with

Returns:

immutable CalculationResult or null if a result is not available

getDataSet

public DataSet getDataSet()

Returns the DataSet to which the CalculationResult belongs to.

Returns:

the DataSet to which the CalculationResult belongs to

getNode

public Node getNode()

Returns the CalculationResult's Node.

Returns:

the CalculationResult's Node

getResultValues

public List<ResultValue> getResultValues()

Returns the Result Values that make up CalculationResult for this Node.

Returns:

Result Values

getResultValue

public ResultValue getResultValue(String label)

Returns a specific ResultValue by its label or null.

Parameters:

label - label of the Result Value to loop up

Returns:

ResultValue identified by the provided label

getConfidenceInterval

public double getConfidenceInterval()

Gets confidence interval value for this result

Returns:

confidence interval

getEntropy

public double getEntropy()

Gets entropy error value for this result

Returns:

entropy error value for this result

getVariance

public double getVariance()

Gets variance value for this result.

Returns:

variance value for this result

getStandardDeviation

public double getStandardDeviation()

Gets standard deviation value for this result.

Returns:

standard deviation value for this result

getMean

public double getMean()

Gets mean value for this result.

Returns:

mean value for this result

getMedian

public double getMedian()

Gets median value for this result.

Returns:

median value for this result

getPercentile

public double getPercentile()

Gets percentile value for this result.

Returns:

percentile value for this result

getLowerPercentile

public double getLowerPercentile()

Gets lower percentile value for this result.

Returns:

lower percentile value for this result

getUpperPercentile

public double getUpperPercentile()

Gets upper percentile value for this result.

Returns:

upper percentile value for this result

isContinuous

public boolean isContinuous()

Returns if the calculation result is for a continuous variable.

Returns:

true if the calculation result is for a continuous variable

toJson

public org.json.JSONObject toJson()

Returns a JSON representation of this object.

Specified by:

toJson in interface Storable

Returns:

JSON

toString

public String toString()

Returns a String value of the JSON representation of this object.

Overrides:

toString in class Object

Returns:

JSON string

toString

public String toString(int indentFactor)

Returns a String value of the JSON representation of this object.

Parameters:

indentFactor - Larger number indicates the depth to which new lines and tabs should be used to indent the JSON string

Returns:

Indented JSON string

getLogicCalculationResult

public uk.co.agena.minerva.model.MarginalDataItem getLogicCalculationResult()

Deprecated. Will be affected by module architecture in the future and should not be used.

Returns the underlying API1 MarginalDataItem object.

Returns:

underlying logic result