ExperimentConfigurationVO (LOG4MEX 1.0.2b API)

java.lang.Object
- org.metarchive.mex.log4mex.InstanceObjects
- - org.metarchive.mex.log4mex.ExperimentConfigurationVO

public class ExperimentConfigurationVO
extends InstanceObjects

Created by esteves on 25.06.15.

Constructor Summary

Constructors
Constructor and Description
`ExperimentConfigurationVO(String id, Integer sequential)`
`ExperimentConfigurationVO(String id, String description, Integer sequential)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addAlgorithm(String algorithmId, org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algorithmClass)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algorithmClass, String algorithmLabel)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, String algorithmLabel)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, String algorithmName, org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algorithmClass, URI algorithmURI)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, String algorithmLabel, org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algorithmClass, URI algorithmURI, String algorithmAcronym)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, String algorithmName, URI algorithmURI)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, URI algorithmURI)` add an Algorithm available in an Experiment Configuration
`String`	`addAlgorithm(String algorithmId, URI algorithmURI, org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algorithmClass)` add an Algorithm available in an Experiment Configuration
`String`	`addExecution(org.metarchive.mex.core.MEXEnum.EnumExecutionsType type, org.metarchive.mex.core.MEXEnum.EnumPhases phase)` add one Execution to the List of Executions in the ExecutionConfiguration
`void`	`addFeature(String featureName)` add a feature associated to a set of executions
`void`	`addFeature(String[] featuresName)` add recursively a set of features associated to a set of executions
`void`	`addToolParameters(String key, String value)` add a tool parameter associated to a set of executions
`AlgorithmVO`	`Algorithm(org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algo)` gets a specific algorithm of a configuration based on the algorithm class
`AlgorithmVO`	`Algorithm(String algoInstanceName)` gets a specific algorithm of a configuration based on the algorithm class
`DataSetVO`	`DataSet()` gets the Dataset of a configuration
`boolean`	`equals(Object other)`
`Execution`	`Execution(String id)`
`protected List<AlgorithmVO>`	`getAlgorithms()` returns all the algorithms of a configuration
`String`	`getDescription()` returns the description of an experiment configuration
`protected List<Execution>`	`getExecutions()`
`protected List<FeatureVO>`	`getFeatures()`
`String`	`getId()` returns the id of an experiment configuration
`String`	`getLabel()` returns the label for an experiment configuration
`protected List<ToolParameterVO>`	`getToolParameters()`
`HardwareConfigurationVO`	`HardwareConfiguration()` gets the Hardware of a configuration
`int`	`hashCode()`
`ModelVO`	`Model()` gets the Model of a configuration
`PhaseVO`	`Phase()` gets the Phase of a configuration
`SamplingMethodVO`	`SamplingMethod()` gets the Sampling Method of a configuration
`void`	`setDataSet(String URI, String name)` set the Dataset associated to a set of executions
`void`	`setDataSet(String URI, String description, String name)` set the Dataset associated to a set of executions
`void`	`setDescription(String _description)` set the experiment configuration description
`void`	`setExecutionEndTime(String executionId, Date value)` set the end time for given execution
`void`	`setExecutionId(Integer index, String id)` set the Execution identification
`void`	`setExecutionStartTime(String executionId, Date value)` set the start time for given execution
`void`	`setHardwareConfiguration(String os, org.metarchive.mex.core.MEXEnum.EnumProcessors cpu, org.metarchive.mex.core.MEXEnum.EnumRAM mb, String hd, org.metarchive.mex.core.MEXEnum.EnumCaches cache)` set the Hardware Configuration associated to a set of executions
`void`	`setId(String _id)` set the experiment configuration id
`void`	`setModel(String id)` set the Model associated to a set of executions
`void`	`setModel(String id, String description)` set the Model associated to a set of executions
`void`	`setModel(String id, String description, Date date)` set the Model associated to a set of executions
`void`	`setSamplingMethod(org.metarchive.mex.core.MEXEnum.EnumSamplingMethods sm, Double train, Double test)` Set the Sampling Method for a given Experiment Configuration.
`void`	`setSamplingMethod(org.metarchive.mex.core.MEXEnum.EnumSamplingMethods sm, Integer folds)` Set the Sampling Method for a given Experiment Configuration.
`void`	`setTool(org.metarchive.mex.core.MEXEnum.EnumTools name, String version)` set the Software Implementation associated to a set of executions
`void`	`setTool(String name, String version)` set the Software Implementation associated to a set of executions
`ToolVO`	`Tool()` gets a Software Implementation of a configuration

Methods inherited from class org.metarchive.mex.log4mex.InstanceObjects
getIndividualName, setIndividualName, setLabel

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperimentConfigurationVO

public ExperimentConfigurationVO(String id,
                                 String description,
                                 Integer sequential)

ExperimentConfigurationVO

public ExperimentConfigurationVO(String id,
                                 Integer sequential)

Method Detail

getLabel
```
public String getLabel()
```
returns the label for an experiment configuration

Overrides:

getLabel in class InstanceObjects

Returns:

getId
```
public String getId()
```
returns the id of an experiment configuration

Returns:

getDescription
```
public String getDescription()
```
returns the description of an experiment configuration

Returns:

Model
```
public ModelVO Model()
```
gets the Model of a configuration

Returns:

Phase
```
public PhaseVO Phase()
```
gets the Phase of a configuration

Returns:

SamplingMethod
```
public SamplingMethodVO SamplingMethod()
```
gets the Sampling Method of a configuration

Returns:

HardwareConfiguration
```
public HardwareConfigurationVO HardwareConfiguration()
```
gets the Hardware of a configuration

Returns:

Tool
```
public ToolVO Tool()
```
gets a Software Implementation of a configuration

Returns:

DataSet
```
public DataSetVO DataSet()
```
gets the Dataset of a configuration

Returns:

Algorithm
```
public AlgorithmVO Algorithm(org.metarchive.mex.core.MEXEnum.EnumAlgorithmsClasses algo)
```
gets a specific algorithm of a configuration based on the algorithm class

Parameters:

algo -

Returns:

Algorithm
```
public AlgorithmVO Algorithm(String algoInstanceName)
```
gets a specific algorithm of a configuration based on the algorithm class

Parameters:

algoInstanceName -

Returns:

Execution

public Execution Execution(String id)

getAlgorithms
```
protected List<AlgorithmVO> getAlgorithms()
```
returns all the algorithms of a configuration

Returns:

getFeatures

protected List<FeatureVO> getFeatures()

getToolParameters

protected List<ToolParameterVO> getToolParameters()

getExecutions

protected List<Execution> getExecutions()

setId
```
public void setId(String _id)
```
set the experiment configuration id

Parameters:

_id -

setDescription
```
public void setDescription(String _description)
```
set the experiment configuration description

Parameters:

_description -

setExecutionStartTime

public void setExecutionStartTime(String executionId,
                                  Date value)

set the start time for given execution

Parameters:: executionId -; value -

setExecutionEndTime

public void setExecutionEndTime(String executionId,
                                Date value)

set the end time for given execution

Parameters:: executionId -; value -

setExecutionId

public void setExecutionId(Integer index,
                           String id)

set the Execution identification

Parameters:: index -; id -

addExecution

public String addExecution(org.metarchive.mex.core.MEXEnum.EnumExecutionsType type,
                           org.metarchive.mex.core.MEXEnum.EnumPhases phase)
                    throws Exception

add one Execution to the List of Executions in the ExecutionConfiguration

Parameters:: type -; phase -
Returns:
Throws:: Exception

addToolParameters

public void addToolParameters(String key,
                              String value)
                       throws Exception

add a tool parameter associated to a set of executions

Parameters:: key -; value -
Throws:: Exception

addFeature
```
public void addFeature(String featureName)
```
add a feature associated to a set of executions

Parameters:

featureName -

addFeature
```
public void addFeature(String[] featuresName)
```
add recursively a set of features associated to a set of executions

Parameters:

featuresName -

setSamplingMethod
```
public void setSamplingMethod(org.metarchive.mex.core.MEXEnum.EnumSamplingMethods sm,
                              Double train,
                              Double test)
                       throws Exception
```
Set the Sampling Method for a given Experiment Configuration. There is an automatic counter in order to deal with more the 1 experiment configuration grouped in 1 experiment, i.e., We would have (for instance) 2 Sampling Methods instances at the same model. Therefore, different id's are required.

Parameters:

sm -

train -

test -

Throws:

Exception

setSamplingMethod
```
public void setSamplingMethod(org.metarchive.mex.core.MEXEnum.EnumSamplingMethods sm,
                              Integer folds)
                       throws Exception
```
Set the Sampling Method for a given Experiment Configuration. There is an automatic counter in order to deal with more the 1 experiment configuration grouped in 1 experiment, i.e., We would have (for instance) 2 Sampling Methods instances at the same model. Therefore, different id's are required.

Parameters:

sm -

folds -

Throws:

Exception

setModel

public void setModel(String id,
                     String description,
                     Date date)

set the Model associated to a set of executions

Parameters:: id -; description -; date -

setModel

public void setModel(String id,
                     String description)

set the Model associated to a set of executions

Parameters:: id -; description -

setModel
```
public void setModel(String id)
```
set the Model associated to a set of executions

Parameters:

id -

setHardwareConfiguration

public void setHardwareConfiguration(String os,
                                     org.metarchive.mex.core.MEXEnum.EnumProcessors cpu,
                                     org.metarchive.mex.core.MEXEnum.EnumRAM mb,
                                     String hd,
                                     org.metarchive.mex.core.MEXEnum.EnumCaches cache)

set the Hardware Configuration associated to a set of executions

Parameters:: os -; cpu -; mb -; hd -; cache -

setDataSet

public void setDataSet(String URI,
                       String description,
                       String name)

set the Dataset associated to a set of executions

Parameters:: URI -; description -; name -

setDataSet

public void setDataSet(String URI,
                       String name)

set the Dataset associated to a set of executions

Parameters:: URI -; name -

setTool

public void setTool(org.metarchive.mex.core.MEXEnum.EnumTools name,
                    String version)

set the Software Implementation associated to a set of executions

Parameters:: name -; version -

setTool

public void setTool(String name,
                    String version)

set the Software Implementation associated to a set of executions

Parameters:: name -; version -