org.ai_heuristic.eval.metric

Class MetricDataset

java.lang.Object

org.ai_heuristic.eval.metric.MetricDataset

Direct Known Subclasses:

MetricCompare

public class MetricDataset
extends java.lang.Object

This class stores a dataset list of objects as a list of MetricValue values. A MetricValue object stores any other object and represents a single data row. It is also assigned a key in the LinkedHashMap if the input does not have one. To represent a single object value, simply add it as is and the method getFirstValue can be used to retrieve it. If a list is added, getNextValue can iterate through all data rows, or getData will return the whole dataset.
Some of the metrics have evaluate methods that can accept simple arrays. You can store these as a single row, or object value, in the dataset and also retrieve as such, when the function calculation should be a bit quicker.

The dataset can be retrieved either as an ordered list or as a keyed and ordered set of values.

Author:

Kieran Greer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetricDataset(MetricValue thisDataObj) Create a new instance of MetricDataset.
protected	MetricDataset(java.lang.String thisValueType, MetricValue thisDataObj) Create a new instance of MetricDataset.
protected	MetricDataset(java.lang.String thisName, java.lang.String thisValueType, java.util.List<?> thisDataset) Create a new instance of MetricDataset.
protected	MetricDataset(java.lang.String thisName, java.lang.String thisValueType, java.util.Map<java.lang.String,?> thisDataset) Create a new instance of MetricDataset.
protected	MetricDataset(java.lang.String thisName, java.lang.String thisValueType, MetricValue thisDataObj) Create a new instance of MetricDataset.
protected	MetricDataset(java.lang.String thisName, java.lang.String thisValueType, T thisDataset) Create a new instance of MetricDataset.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<MetricValue>	getData() Get a copy of the whole data list.
java.util.ArrayList<java.lang.String>	getDataKeys() Get a copy of the ordered list of keys that represent each data value entry.
int	getDatasetSize() Get the size of the dataset.
java.lang.Object	getFirstValue() This resets the value iterator to point to the first value in the LinkedHashMap list and returns that value directly, not the enclosing MetricValue object.
java.lang.String	getName() Get the id or name of this value structure.
java.lang.Object	getNextValue() This uses the current iterator to return the next value in the LinkedHashMap list and returns that value directly, not the enclosing MetricValue object.
java.util.HashMap<java.lang.String,java.lang.Object>	getParams() Get the additional parameters list.
java.lang.Object	getValue() Get the actual node value, not the enclosing MetricValue object.
java.lang.Object	getValue(java.lang.String dataKey) Get the actual node value, not the enclosing MetricValue object, relating to a specific entry key.
java.lang.String	getValueType() Get the data type.
boolean	hasNextValue() Return true if the value iterator still has element to return.
static boolean	isDataset(java.lang.Object thisData) Return true if the data object is already a MetricDataset type.
boolean	isSingleValue() Return true if the dataset stores a single value only.
void	resetValueIterator() Reset the value iterator to the start element.
void	setName(java.lang.String thisName) Set the id or name of this value structure.
void	setParams(java.util.HashMap<java.lang.String,java.lang.Object> theParams) Set the arbitrary parameters list.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.util.ArrayList<?> dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.util.HashMap<java.lang.String,?> dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.util.Hashtable<java.lang.String,?> dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.util.LinkedHashMap<?,?> dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, MetricValue dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.lang.String dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static <T> MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, T dataPoints) Create a metric dataset object by calling the constructor with the closest match to the data object passed in.
static MetricDataset	toDataset(java.lang.String name, java.lang.String valueType, java.util.Vector<?> dataPoints) Create a metric dataset object where each array value is added as a MetricValue object to the dataset.
static <T> MetricDataset	toDataset(java.lang.String valueType, T dataPoints) Create a metric dataset object by calling the constructor with the closest match to the data object passed in.
static <T> MetricDataset	toDataset(T dataPoints) Create a metric dataset object by calling the constructor with the closest match to the data object passed in.
java.lang.String	toString() Get a String-based representation of this metric value object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricDataset

protected MetricDataset(MetricValue thisDataObj)
                 throws java.lang.Exception

Create a new instance of MetricDataset. Some functions might only require storing a data value, where the type is already known and indexing is not required. So this constructor will set the name and valueType to null.

Parameters:

thisDataObj - a single data object that gets added to the dataList.

Throws:

java.lang.Exception - any error.

MetricDataset

protected MetricDataset(java.lang.String thisValueType,
                        MetricValue thisDataObj)
                 throws java.lang.Exception

Create a new instance of MetricDataset. This creates a list with a single object, as passed in, but with a unique key name.

Parameters:

thisValueType - the type of data object.

thisDataObj - a single data object that gets added to the dataList.

Throws:

java.lang.Exception - any error.

MetricDataset

protected MetricDataset(java.lang.String thisName,
                        java.lang.String thisValueType,
                        MetricValue thisDataObj)
                 throws java.lang.Exception

Create a new instance of MetricDataset. This creates a list with a single object, as passed in, but with a unique key name.

Parameters:

thisName - a unique name or id for the whole dataset. Can be null.

thisValueType - the type of data object.

thisDataObj - a single data object that gets added to the dataList.

Throws:

java.lang.Exception - any error.

MetricDataset

protected MetricDataset(java.lang.String thisName,
                        java.lang.String thisValueType,
                        java.util.Map<java.lang.String,?> thisDataset)
                 throws java.lang.Exception

Create a new instance of MetricDataset.

Parameters:

thisName - a unique name or id for the dataset. Can be null.

thisValueType - the type of data object.

thisDataset - a list of data objects to evaluate. These can be of any type, but are converted to MetricValue before storing in the dataMap. As part of the conversion, a unique id is assigned to each point in the dataMap, that is different to any original MetricValue name. Note that a HashMap ordering is undetermined.

Throws:

java.lang.Exception - any error.

MetricDataset

protected MetricDataset(java.lang.String thisName,
                        java.lang.String thisValueType,
                        T thisDataset)
                 throws java.lang.Exception

Create a new instance of MetricDataset. This might be more appropriate for internal use only.

Parameters:

thisName - a unique name or id for the dataset. Can be null.

thisValueType - the type of data object.

thisDataset - the dataset representation. This is stored as a single MetricValue value, where the value itself could be a single object or a list, for example, but is not changed further inside the MetricValue.

Throws:

java.lang.Exception - any error.

MetricDataset

protected MetricDataset(java.lang.String thisName,
                        java.lang.String thisValueType,
                        java.util.List<?> thisDataset)
                 throws java.lang.Exception

Create a new instance of MetricDataset.

Parameters:

thisName - a unique name or id for the dataset. Can be null.

thisValueType - the type of data object.

thisDataset - a list of data objects to evaluate. These can be of any type, but are converted to MetricValue before storing in the dataList. As part of the conversion, a unique id is assigned to each point in the dataMap, that is different to any original MetricValue name.

Throws:

java.lang.Exception - any error.

Method Detail

isDataset

public static boolean isDataset(java.lang.Object thisData)

Return true if the data object is already a MetricDataset type.

Parameters:

thisData - the data object to evaluate.

Returns:

true if not null and a MetricDataset, false otherwise.

isSingleValue

public boolean isSingleValue()

Return true if the dataset stores a single value only.

Returns:

true if the dataset size is 1, false otherwise.

getValueType

public java.lang.String getValueType()

Get the data type. This can be set here, where if it is null, it is extracted from the first dataset value that would typically be of type MetricValue.

Returns:

the type of data that is stored.

getDatasetSize

public int getDatasetSize()

Get the size of the dataset.

Returns:

the number of elements in the dataset.

resetValueIterator

public void resetValueIterator()

Reset the value iterator to the start element.

getFirstValue

public java.lang.Object getFirstValue()

This resets the value iterator to point to the first value in the LinkedHashMap list and returns that value directly, not the enclosing MetricValue object. If the dataset is used for storing a single value only, then this method can be used to retrieve it.

Returns:

the MetricValue.getValue() value for the first list element.

hasNextValue

public boolean hasNextValue()

Return true if the value iterator still has element to return.

Returns:

true if value iterator can still return elements.

getNextValue

public java.lang.Object getNextValue()

This uses the current iterator to return the next value in the LinkedHashMap list and returns that value directly, not the enclosing MetricValue object. If the iterator has not been used, it returns the same result as getFirstData.

Returns:

the MetricValue.getValue() value for the next list element.

getValue

public java.lang.Object getValue()

Get the actual node value, not the enclosing MetricValue object.

Returns:

an ArrayList of values, or single value using value.getFirstValue(), or null for no value.

getValue

public java.lang.Object getValue(java.lang.String dataKey)

Get the actual node value, not the enclosing MetricValue object, relating to a specific entry key.

Parameters:

dataKey - the key in the dataKeys list.

Returns:

a single value from a list of values, or null for no key or value.

getDataKeys

public java.util.ArrayList<java.lang.String> getDataKeys()

Get a copy of the ordered list of keys that represent each data value entry. Only a copy so that the dataset cannot be permanently changed.

Returns:

the data keys, one for each data value entry. These ca be egenrated automatically or copied from a hash map, for example.

getData

public java.util.ArrayList<MetricValue> getData()

Get a copy of the whole data list. Only a copy and the metric values should not be permanently changed.

Returns:

the value of dataValues, which will probably need to be parsed further to extract the MetricValue data values.

setName

public void setName(java.lang.String thisName)

Set the id or name of this value structure.

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.

setParams

public void setParams(java.util.HashMap<java.lang.String,java.lang.Object> theParams)

Set the arbitrary parameters list.

Parameters:

theParams - a list of parameters for any use.

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Get the additional parameters list.

Returns:

the value of params.

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 static <T> MetricDataset toDataset(T dataPoints)
                                   throws java.lang.Exception

Create a metric dataset object by calling the constructor with the closest match to the data object passed in. If dataPoints is already a MetricDataset then return it exactly as is, without any changes.
The following rules also apply:
1. A single String value can be added as is, or if the value type is char, then it is converted to a list of chars.
2. Arrays of simple types are allowed and are now stored and retrieved as a single object in the MetricValue object.
3. ArrayList's are converted to the internal map structure, unless the data type is also an ArrayList, when it will be stored and retrieved as a single object.
4. Map's are converted to the internal map structure, unless the data type is also the Map (not the element type), when it will be stored and retrieved as a single object.

Parameters:

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static <T> MetricDataset toDataset(java.lang.String valueType,
                                          T dataPoints)
                                   throws java.lang.Exception

Create a metric dataset object by calling the constructor with the closest match to the data object passed in. If dataPoints is already a MetricDataset then return it exactly as is, without any changes.
The following rules also apply:
1. A single String value can be added as is, or if the value type is char, then it is converted to a list of chars.
2. Arrays of simple types are allowed and are now stored and retrieved as a single object in the MetricValue object.
3. ArrayList's are converted to the internal map structure, unless the data type is also an ArrayList, when it will be stored and retrieved as a single object.
4. Map's are converted to the internal map structure, unless the data type is also the Map (not the element type), when it will be stored and retrieved as a single object.

Parameters:

valueType - the type of data to add. This will also convert a single String into a list of chars, if the Character or char value type is indicated.

dataPoints - the list of data points to add. This can include arrays, or a String that needs to be converted into chars. A single data point is also possible that can be added simply as is. This data type overrides the valueType entry. A MetricValue entry is a simply added as is.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static <T> MetricDataset toDataset(java.lang.String name,
                                          java.lang.String valueType,
                                          T dataPoints)
                                   throws java.lang.Exception

Create a metric dataset object by calling the constructor with the closest match to the data object passed in. If dataPoints is already a MetricDataset then return it exactly as is, without any changes.
The following rules also apply:
1. A single String value can be added as is, or if the value type is char, then it is converted to a list of chars.
2. Arrays of simple types are allowed and are now stored and retrieved as a single object in the MetricValue object.
3. ArrayList's are converted to the internal map structure, unless the data type is also an ArrayList, when it will be stored and retrieved as a single object.
4. Map's are converted to the internal map structure, unless the data type is also the Map (not the element type), when it will be stored and retrieved as a single object.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add. This will also convert a single String into a list of chars, if the Character or char value type is indicated.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      MetricValue dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add, as a MetricValue list.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.util.ArrayList<?> dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.util.Vector<?> dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.util.HashMap<java.lang.String,?> dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.util.Hashtable<java.lang.String,?> dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.util.LinkedHashMap<?,?> dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.

toDataset

public static MetricDataset toDataset(java.lang.String name,
                                      java.lang.String valueType,
                                      java.lang.String dataPoints)
                               throws java.lang.Exception

Create a metric dataset object where each array value is added as a MetricValue object to the dataset. This is the standard way to store and retrieve the data.

Parameters:

name - a name to give the dataset.

valueType - the type of data to add. This will also convert a single String into a list of chars, if the Character or char value type is indicated.

dataPoints - the list of data points to add.

Returns:

the created metric dataset.

Throws:

java.lang.Exception - any error.