org.ai_heuristic.eval.metric

Class MetricValue

java.lang.Object

org.ai_heuristic.eval.metric.MetricValue

public class MetricValue
extends java.lang.Object

This represents a single data value. The data object/point can be assigned a name, making indexing possible and the data value can be anything. The receiving algorithm should be able to properly interpret the data object and there is a data type to help with this. In some cases the name or type can be null, if this class is used as a container for a value only.

Author:

Kieran Greer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetricValue(java.lang.String thisValueName, java.lang.String thisValueType, java.lang.Object thisObjValue) Create a new instance of MetricValue.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the id or name of this value structure.
java.lang.Object	getValue() Get the object value.
java.lang.String	getValueType() Get the type of the object value.
void	setName(java.lang.String thisName) Set the id or name of this data value.
void	setValue(java.lang.Object thisObjValue) Set the object value.
MetricDataset	toDataset() Create a new dataset, with this object value as a single value in it, or return this value if it is already a MetricDataset.
java.lang.String	toString() Get a String-based representation of this metric value object.
static MetricValue	toValue() Create an empty metric value object to be filled in later.
static MetricValue	toValue(java.lang.Object dataPoint) Create a metric value object that stores the single data point as is.
static MetricValue	toValue(java.lang.String name, java.lang.String valueType, java.lang.Object dataPoint) Create a metric value object that stores the single data point as is.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricValue

protected MetricValue(java.lang.String thisValueName,
                      java.lang.String thisValueType,
                      java.lang.Object thisObjValue)

Create a new instance of MetricValue.

Parameters:

thisValueName - a unique name for the value point. Can be null if not used.

thisValueType - the type of value that is stored - typically the class name. Can be null if not used.

thisObjValue - the data value.

Method Detail

setName

public void setName(java.lang.String thisName)

Set the id or name of this data value.

Parameters:

thisName - the value object name.

getName

public java.lang.String getName()

Get the id or name of this value structure.

Returns:

the value of name.

getValueType

public java.lang.String getValueType()

Get the type of the object value.

Returns:

the value of valueType.

setValue

public void setValue(java.lang.Object thisObjValue)

Set the object value.

Parameters:

thisObjValue - the value object.

getValue

public java.lang.Object getValue()

Get the object value.

Returns:

the value of objValue.

toString

public java.lang.String toString()

Get a String-based representation of this metric value object.

Overrides:

toString in class java.lang.Object

Returns:

a String-based description of this object.

toDataset

public MetricDataset toDataset()
                        throws java.lang.Exception

Create a new dataset, with this object value as a single value in it, or return this value if it is already a MetricDataset.

Returns:

a MetricDataset representation of this value.

Throws:

java.lang.Exception - any error.

toValue

public static MetricValue toValue()
                           throws java.lang.Exception

Create an empty metric value object to be filled in later. This may be useful simply as a container to pass any of the information fields.

Returns:

the created metric value.

Throws:

java.lang.Exception - any error.

toValue

public static MetricValue toValue(java.lang.Object dataPoint)
                           throws java.lang.Exception

Create a metric value object that stores the single data point as is. Both the name and the value type are set to null.

Parameters:

dataPoint - the data point to add. This is added as is, without any type checking or conversions, so if it is a list, maybe the MetricDataset.toDataset should be preferred.

Returns:

the created metric value.

Throws:

java.lang.Exception - any error.

toValue

public static MetricValue toValue(java.lang.String name,
                                  java.lang.String valueType,
                                  java.lang.Object dataPoint)
                           throws java.lang.Exception

Create a metric value object that stores the single data point as is.

Parameters:

name - a name to give the data point. This can be null, if the name is not used.

valueType - the type of the data point. This can be null, if the name is not used.

dataPoint - the data point to add. This is added as is, without any type checking or conversions, so if it is a list, maybe the MetricDataset.toDataset should be preferred.

Returns:

the created metric value.

Throws:

java.lang.Exception - any error.