org.licas.ai_solver.spec

Class ProblemScript

java.lang.Object

org.licas.service.spec.ServiceSpec

org.licas.service.spec.BehaviourScript

org.licas.ai_solver.spec.ProblemScript

Direct Known Subclasses:

GridProblemScript, KnnProblemScript, SomProblemScript

public class ProblemScript
extends org.licas.service.spec.BehaviourScript

This class reads an XML file and loads in a specification for a set of test runs. The TestSpec and ProblemMediator classes can then be created from this script specification. Some of the values need to be hard coded as part of a test class, but the ones that repeat or are changed can be included in this script.

Field Summary

Fields

Modifier and Type	Field and Description
int	maxSolutionNum Maximum number of solutions or possibly a beam width.
double	rangeValue The value for considering scores as the same.
boolean	similarityRangeAsPercentage If true, then the comparison range is a percentage of the value, if false, then it is an exact amount.
java.lang.String	solverType The solver framework is the controlling framework in which the heuristics are run.
TestRunsScript	testRunsScript Configuration for the test runs themselves.

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

maxValue, minValue, scriptType

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
ProblemScript(org.licas.PasswordHandler thePasswordHandler) Create a new instance of ProblemScript.

Method Summary

Modifier and Type	Method and Description
boolean	convertForInitialise() Convert the set of values into the structure to be used to initialise the test services.
void	copy(org.licas.service.spec.BehaviourScript behaviourScript) Copy the behaviour script values into this object.
java.lang.String	validateScript() Validate the whole script and return a description of any errors.
protected java.lang.String	validateVariable(java.lang.String varType) Validate the script variable and return a description if invalid.

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

getDatasetType, getDirFolder, getHeuristicType, getTokenizer, parseProblemDataset, setDatasetType, setDirFolder, setHeuristicType, setTokenizer

Methods inherited from class java.lang.Object

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

Field Detail

solverType

public java.lang.String solverType

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

maxSolutionNum

public int maxSolutionNum

Maximum number of solutions or possibly a beam width. Especially if evolving solutions, the number can grow, so this is a maximum total number that is allowed.

rangeValue

public double rangeValue

The value for considering scores as the same. This is defined as actual or a percentage and is used when comparing, to determine that two values are close enough to be considered the same.

similarityRangeAsPercentage

public boolean similarityRangeAsPercentage

If true, then the comparison range is a percentage of the value, if false, then it is an exact amount.

testRunsScript

public TestRunsScript testRunsScript

Configuration for the test runs themselves.

Constructor Detail

ProblemScript

public ProblemScript(org.licas.PasswordHandler thePasswordHandler)

Create a new instance of ProblemScript.

Parameters:

thePasswordHandler - for storing passwords.

Method Detail

convertForInitialise

public boolean convertForInitialise()
                             throws java.lang.Exception

Convert the set of values into the structure to be used to initialise the test services. this depends on the framework, or solver type. The script is already setup for the centralised problem-solving and so does not need to be changed for that, for example, but the distributed linking can be more easily initialised as the behaviour tests.

Returns:

true if converted OK.

Throws:

java.lang.Exception - any error.

copy

public void copy(org.licas.service.spec.BehaviourScript behaviourScript)

Copy the behaviour script values into this object.

Parameters:

behaviourScript - the behaviour script.

validateScript

public java.lang.String validateScript()

Validate the whole script and return a description of any errors.

Overrides:

validateScript in class org.licas.service.spec.BehaviourScript

Returns:

a description of any errors or null if OK.

validateVariable

protected java.lang.String validateVariable(java.lang.String varType)

Validate the script variable and return a description if invalid.

Overrides:

validateVariable in class org.licas.service.spec.BehaviourScript

Parameters:

varType - the variable type.

Returns:

a description of any error, of null if OK.