org.licas.service.spec

Class ServiceSpec

java.lang.Object

org.licas.service.spec.ServiceSpec

Direct Known Subclasses:

BehaviourScript

public class ServiceSpec
extends java.lang.Object

This class can provide a general specification for creating or loading services onto a server or network.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<java.lang.Object>	constructorParams Parameters to initialise the base service with.
boolean	createServices If true create the services on the specified server, if false test without services
java.util.ArrayList<java.lang.String>	dataConditions List of conditions under which data can be generated or read.
java.lang.String	datasetType The type of dataset to use
java.lang.String	dirPath The directory to read the files from
java.lang.String	externalScript The file path to read an external script from
java.util.HashMap<java.lang.String,java.lang.Object>	heuristicOptions A list of different heuristic options.
java.lang.String	heuristicType The type of heuristic to use.
java.util.HashMap<java.lang.String,java.lang.Object>	inputVariables Arbitrary list of key-value pairs for processing in solutions.
LinkSpec	linkSpec Linking specification
java.lang.String	metricType The type of metric to use, for example.AiHeuristicConst.EUCLIDEANFUNCTION.
ServerSpec	serverSpec Server config specification
java.util.HashMap<java.lang.String,java.lang.String>	serviceClasses Service classes.
java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>	serviceJarFiles Service jar files.
int	servicesNum Number of services or solutions - also the initial number to create
java.lang.String	serviceType The test service type
java.lang.String	tokenizer The character to separate dataset values

Constructor Summary

Constructors

Constructor and Description
ServiceSpec(PasswordHandler thePasswordHandler) Create a new instance of ServiceSpec.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	parseProblemDataset(java.lang.String datasetType, org.licas_xml.abs.Element dataXml) Parse a problem dataset in XML format to create the associated 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 java.lang.Object

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

Field Detail

datasetType

public java.lang.String datasetType

The type of dataset to use

dirPath

public java.lang.String dirPath

The directory to read the files from

tokenizer

public java.lang.String tokenizer

The character to separate dataset values

servicesNum

public int servicesNum

Number of services or solutions - also the initial number to create

createServices

public boolean createServices

If true create the services on the specified server, if false test without services

serviceClasses

public java.util.HashMap<java.lang.String,java.lang.String> serviceClasses

Service classes. Key is the service type and value is the class name.

constructorParams

public java.util.ArrayList<java.lang.Object> constructorParams

Parameters to initialise the base service with. Can contain service password, admin key and admin script.

heuristicType

public java.lang.String heuristicType

The type of heuristic to use. This defines the type of problem solver to use, or the problem solving mechanism.

metricType

public java.lang.String metricType

The type of metric to use, for example.AiHeuristicConst.EUCLIDEANFUNCTION. This defines the evaluation function that the problem-solving heuristic should use.

serviceType

public java.lang.String serviceType

The test service type

dataConditions

public java.util.ArrayList<java.lang.String> dataConditions

List of conditions under which data can be generated or read. This could be a list of file directory paths to read file contents from, or it could be a set or range of allowed values, represented in String format.

heuristicOptions

public java.util.HashMap<java.lang.String,java.lang.Object> heuristicOptions

A list of different heuristic options. For example, genetic algorithms require the evolve types. Key is the variable name and value is the value. These are more for initialisation purposes.

inputVariables

public java.util.HashMap<java.lang.String,java.lang.Object> inputVariables

Arbitrary list of key-value pairs for processing in solutions. Maybe not for initialising, but for run-time passing of values.

serviceJarFiles

public java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> serviceJarFiles

Service jar files. Key is the service type and value is a list or required jar files.

externalScript

public java.lang.String externalScript

The file path to read an external script from

linkSpec

public LinkSpec linkSpec

Linking specification

serverSpec

public ServerSpec serverSpec

Server config specification

Constructor Detail

ServiceSpec

public ServiceSpec(PasswordHandler thePasswordHandler)

Create a new instance of ServiceSpec.

Parameters:

thePasswordHandler - for storing passwords.

Method Detail

validateScript

public java.lang.String validateScript()

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

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.

Parameters:

varType - the variable type.

Returns:

a description of any error, of null if OK.

parseProblemDataset

public java.lang.Object parseProblemDataset(java.lang.String datasetType,
                                            org.licas_xml.abs.Element dataXml)
                                     throws java.lang.Exception

Parse a problem dataset in XML format to create the associated object. This can be anything depending on what sort of data is being processed, so any derived class need to implement this to be application specific.

Parameters:

datasetType - the type of dataset to be parsed.

dataXml - the dataset description in XML.

Returns:

the parsed object.

Throws:

java.lang.Exception - any error.