org.licas.ai_solver.mediator.problem

Class ProblemMediator

java.lang.Object

org.licas.service.spec.ServiceSpec

org.licas.ai_solver.mediator.problem.ProblemMediator

All Implemented Interfaces:

ProblemMediatorDef

Direct Known Subclasses:

ProblemMediatorCentral, ProblemMediatorDistributed

public abstract class ProblemMediator
extends org.licas.service.spec.ServiceSpec
implements ProblemMediatorDef

This class should be implemented by all problem specification classes. This abstract base class contains the main parameter list that might be used for specifying general problems. The derived classes then provide more specific methods and parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected Result	bestResult The current best result
protected boolean	fullTrace True if store full test trace, but still need to add it.
protected Problem	problem This models the problem to be solved
protected Result	result The current result
protected java.util.ArrayList<java.lang.String>	solutionOrder A solution ordering if required.
protected java.util.LinkedHashMap<java.lang.String,Solution>	solutionSet The list of solution instances related to this problem.
protected int	solutionsNumber Number of solutions to create
protected java.lang.String	solverType The solver framework is the controlling framework in which the heuristics are run.
protected boolean	testEnded True if the tests have ended or should be stopped

Fields inherited from class org.licas.service.spec.ServiceSpec

constructorParams, createServices, dataConditions, datasetType, dirPath, externalScript, heuristicOptions, heuristicType, inputVariables, linkSpec, metricType, serverSpec, serviceClasses, serviceJarFiles, servicesNum, serviceType, tokenizer

Constructor Summary

Constructors

Constructor and Description
ProblemMediator(org.licas.PasswordHandler thePasswordHandler) Create a new instance of ProblemMediator.

Method Summary

Modifier and Type	Method and Description
void	addHeuristicOption(java.lang.String name, java.lang.Object value) Add a new heuristic-related variable value.
void	clearHeuristicOptions() Clear the list of heuristic-related variable values.
void	copyToConfig(TestSpec testSpec) Copy any values specific to the problem solver classes to the related specific structures, from the more general list of variables from the Problem Spec itself.
boolean	getFullTrace() Get the value indicating if a full test trace should be stored for output.
java.util.HashMap<java.lang.String,java.lang.Object>	getHeuristicOptions() Get the list of heuristic-related variable values.
java.lang.String	getHeuristicType() Get the type of heuristic to use.
Problem	getProblem() Get the problem model.
java.util.ArrayList<java.lang.String>	getProblemNames() Get the ordered list of solution names.
java.util.LinkedHashMap<java.lang.String,Solution>	getSolutionSet() Get the list of compound solution instances.
int	getSolutionsNumber() Get the number of solutions to create.
boolean	getTestEnded() Return true if the tests have ended or should be stopped.
ProcessResult	processResult(java.lang.String solverType) Calculate any stats on the clustered solutions.
abstract boolean	resetForNextRun(java.util.HashMap<java.lang.String,?> varList) Reset the problem-solving structures for the next run.
void	resetValues() Reset to starting values
void	setDatasetType(java.lang.String thisDatasetType) Set the dataset type.
void	setFullTrace(boolean thisFullTrace) Set the value indicating if a full test trace should be stored for output.
void	setHeuristicOptions(java.util.HashMap<java.lang.String,java.lang.Object> thisHeuristicOptions) Set the list of heuristic options, as key-value pairs.
void	setHeuristicType(java.lang.String thisHeuristicType) Set the type of heuristic to use.
void	setProblem(Problem thisProblem) Set the problem model.
void	setSolutionSet(java.util.LinkedHashMap thisSolutionsList) Set the list of compound solution instances related to the problem.
void	setSolutionsNumber(int thisSolutionsNumber) Set the number of solutions to create.

Methods inherited from class org.licas.service.spec.ServiceSpec

getDatasetType, getDirFolder, getTokenizer, parseProblemDataset, setDirFolder, setTokenizer, validateScript, validateVariable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.licas.ai_solver.def.ProblemMediatorDef

getResultXml, solve

Field Detail

solverType

protected java.lang.String solverType

The solver framework is the controlling framework in which the heuristics are run. It can include HeuristicConst.GRIDMATCH or SEARCHHILL, for example.

solutionsNumber

protected int solutionsNumber

Number of solutions to create

testEnded

protected boolean testEnded

True if the tests have ended or should be stopped

fullTrace

protected boolean fullTrace

True if store full test trace, but still need to add it. If false only the result of an evaluation is stored.

solutionOrder

protected java.util.ArrayList<java.lang.String> solutionOrder

A solution ordering if required. Stores the solution names.

solutionSet

protected java.util.LinkedHashMap<java.lang.String,Solution> solutionSet

The list of solution instances related to this problem. Key is the solution name and value is of type 'Solution' (or derived). Note that correct order may not be the order they are added in.

problem

protected Problem problem

This models the problem to be solved

bestResult

protected Result bestResult

The current best result

result

protected Result result

The current result

Constructor Detail

ProblemMediator

public ProblemMediator(org.licas.PasswordHandler thePasswordHandler)

Create a new instance of ProblemMediator.

Parameters:

thePasswordHandler - for storing passwords.

Method Detail

resetValues

public void resetValues()

Reset to starting values

resetForNextRun

public abstract boolean resetForNextRun(java.util.HashMap<java.lang.String,?> varList)
                                 throws java.lang.Exception

Reset the problem-solving structures for the next run. In this case, remove the named solutions from the list of current ones.

Parameters:

varList - a list of variables as key-value pairs.

Returns:

true if all are removed, false otherwise.

Throws:

java.lang.Exception - any error.

processResult

public ProcessResult processResult(java.lang.String solverType)
                            throws java.lang.Exception

Calculate any stats on the clustered solutions.

Specified by:

processResult in interface ProblemMediatorDef

Parameters:

solverType - the solver used to create the result.

Returns:

the results of analysing the clusters.

Throws:

java.lang.Exception - any error.

copyToConfig

public void copyToConfig(TestSpec testSpec)
                  throws java.lang.Exception

Copy any values specific to the problem solver classes to the related specific structures, from the more general list of variables from the Problem Spec itself.

Specified by:

copyToConfig in interface ProblemMediatorDef

Parameters:

testSpec - the model of the tests to perform.

Throws:

java.lang.Exception - any error.

getProblemNames

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

Get the ordered list of solution names.

Returns:

the solutions ordering list of names, so that index on it can be used.

setDatasetType

public void setDatasetType(java.lang.String thisDatasetType)

Set the dataset type. This is the actual class name.

Overrides:

setDatasetType in class org.licas.service.spec.ServiceSpec

Parameters:

thisDatasetType - the dataset type.

setHeuristicType

public void setHeuristicType(java.lang.String thisHeuristicType)

Set the type of heuristic to use.

Overrides:

setHeuristicType in class org.licas.service.spec.ServiceSpec

Parameters:

thisHeuristicType - the test heuristic.

getHeuristicType

public java.lang.String getHeuristicType()

Get the type of heuristic to use.

Overrides:

getHeuristicType in class org.licas.service.spec.ServiceSpec

Returns:

the value of heuristicType.

clearHeuristicOptions

public void clearHeuristicOptions()

Clear the list of heuristic-related variable values.

addHeuristicOption

public void addHeuristicOption(java.lang.String name,
                               java.lang.Object value)

Add a new heuristic-related variable value.

Parameters:

name - a variable name.

value - related value. Can be null for no value.

setHeuristicOptions

public void setHeuristicOptions(java.util.HashMap<java.lang.String,java.lang.Object> thisHeuristicOptions)

Set the list of heuristic options, as key-value pairs.

Parameters:

thisHeuristicOptions - the value of heuristicOptions.

getHeuristicOptions

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

Get the list of heuristic-related variable values. Values can be null.

Returns:

the value of heuristicOptions.

setProblem

public void setProblem(Problem thisProblem)

Set the problem model.

Parameters:

thisProblem - a description of the problem in terms of tasks to be solved.

getProblem

public Problem getProblem()

Get the problem model.

Returns:

the value of problem.

setSolutionsNumber

public void setSolutionsNumber(int thisSolutionsNumber)

Set the number of solutions to create.

Parameters:

thisSolutionsNumber - the number of solutions.

getSolutionsNumber

public int getSolutionsNumber()

Get the number of solutions to create.

Returns:

the totalValue of solutionsNumber.

setSolutionSet

public void setSolutionSet(java.util.LinkedHashMap thisSolutionsList)

Set the list of compound solution instances related to the problem.

Parameters:

thisSolutionsList - the list of solution instances.

getSolutionSet

public java.util.LinkedHashMap<java.lang.String,Solution> getSolutionSet()

Get the list of compound solution instances.

Returns:

the value of solutionsList.

getTestEnded

public boolean getTestEnded()

Return true if the tests have ended or should be stopped. This is not set automatically and needs to be implemented by any derived class.

Returns:

the value of testEnded.

setFullTrace

public void setFullTrace(boolean thisFullTrace)

Set the value indicating if a full test trace should be stored for output.

Parameters:

thisFullTrace - true if save a full trace.

getFullTrace

public boolean getFullTrace()

Get the value indicating if a full test trace should be stored for output.

Returns:

the value of fullTrace.