org.licas.ai_solver.distrib

Class ClusterLinkService

java.lang.Object

java.lang.Thread

org.licas.Service

org.licas.service.sci.DataService

org.licas.ai_solver.distrib.ClusterLinkService

All Implemented Interfaces:

java.lang.Runnable, org.licas.def.evaluate.DataServiceDef, org.licas.def.evaluate.EvaluateServiceDef

Direct Known Subclasses:

CompleteLinkService, ContainsLinkService, SingleLinkService

public abstract class ClusterLinkService
extends org.licas.service.sci.DataService

Base class for linking services using the clustering algorithms. Problem-solving using linking services would potentially be a distributed alternative to using the centralised hyper-heuristic or matching framework. In particular, the linking should probably replace genetic algorithm solutions, as the main result mechanism, but a plug-in architecture should allow things to be flexible. Note that these services must be added to a parent of type LinkService or derived, to access the linking methods.

Author:

Kieran Greer

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap	allData Datasets from all available services.
protected java.util.ArrayList	clusterURIs List of service IDs/URIs that are clustered with this service.
protected org.ai_heuristic.functs.Function	evalMetric The evaluation metric
protected int	numberOfIterations Number of test run iterations, if specified

Fields inherited from class org.licas.service.sci.DataService

allDatasets, dataObj, dataType, mathCompare, mathOpMethod, rnd

Fields inherited from class org.licas.Service

canAccessMeta, canAccessNested, finalised, isRemoteCall, jarFile, lastAddedCommunicationID, messageStore, parent, passwordHandler, serviceAdmin, serviceGrade, serviceInitialise, serviceLinks, serviceState, serviceType, shutDown, toLoadScript, uuid

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ClusterLinkService() Create a new instance of ClusterLinkService.
ClusterLinkService(java.lang.String thisPassword, java.lang.String thisAdminKey) Creates a new instance of ClusterLinkService.
ClusterLinkService(java.lang.String thisPassword, java.lang.String thisAdminKey, org.licas_xml.abs.Element adminXml) Creates a new instance of ClusterLinkService.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	alreadyLinkedTo(java.lang.String linkTo) Check for existing links to the selected service, as part of a cluster.
protected java.lang.String	getMetricType() Get the evaluation metric type, if initialised with the info in the admin Meta element.
protected boolean	iterationsOK(int maxIterations) Return true if the current iterations value is OK with respect to a maximum value.
void	resetValues() Reset variables for another test run.

Methods inherited from class org.licas.service.sci.DataService

createEvaluateData, evaluate, getData, getDataType, getInstanceValue, sendInfoXML, setData, setDataType, setGenData, setInstanceValues, setLocalDataset, setSerializeValues

Methods inherited from class org.licas.Service

addCommunicationID, addDefaultService, addDefaultService, addDefaultService, addDefaultService, addLinkFromService, addLinkToService, addMessageMetrics, addService, addService, addService, addService, addServiceAssociation, addServicePassword, addTempPassword, allowAddService, canAccess, canAccess, canAccess, canAccess, canAccess, canAccessMeta, canAccessNested, canAccessTemp, clearServices, clearServices, createMetaForRepos, createMetaFull, createPermanentLinkTo, createServiceWrapper, defaultAdminToRemove, dynamicLinksToPermanent, dynamicLinksToXml, dynamicLinksToXml, execute, finaliseInitialisation, finaliseInitialisation, finaliseThisConfig, finalize, GET, getAllLinkToService, getAllowAddService, getAutonomicManagerConfig, getDescription, getFullPath, getIsRemoteCall, getJarFile, getLinkFromService, getLinkToService, getLocalRemoteKey, getParent, getPassword, getPassword, getPassword, getPassword, getPublicMethods, getPublicServiceClassname, getServerPassword, getService, getService, getServiceAdmin, getServiceClasses, getServiceGrade, getServiceNames, getServiceNames, getServiceNames, getServiceOrWrapper, getServicePassword, getServiceState, getServiceType, getServiceType, getServiceTypes, getShutDown, getUUID, handshake, hasCommunicationID, hasLinkTo, hasService, hasServiceType, interrupt, interrupt, isAdminKey, isCorrectPassword, isPublicMethod, linksToXml, loadObject, messageRetrieve, messageStore, messageTransit, passwordsStateToXml, permanentLinksToXml, removeAllLinksTo, removeAllServices, removeAllServices, removeCommunicationID, removeLinkFromService, removeLinkToService, removePermanentLinkTo, removeService, removeService, removeService, removeServiceAssociation, removeTempPassword, serviceNegotiate, serviceToXml, serviceToXml, setAdminInfo, setCanAccessMeta, setCanAccessNested, setData, setDescription, setIsRemoteCall, setJarFile, setOtherMeta, setParent, setServerPassword, setServiceType, setShutDown, setUUID, startAllThreads, startThread, stopAllThreads, threadAliveState, xmlToDynamicLinks, xmlToService

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

numberOfIterations

protected int numberOfIterations

Number of test run iterations, if specified

allData

protected java.util.HashMap allData

Datasets from all available services. Key is service ID, value is data object.

clusterURIs

protected java.util.ArrayList clusterURIs

List of service IDs/URIs that are clustered with this service.

evalMetric

protected org.ai_heuristic.functs.Function evalMetric

The evaluation metric

Constructor Detail

ClusterLinkService

public ClusterLinkService()
                   throws java.lang.Exception

Create a new instance of ClusterLinkService.

Throws:

java.lang.Exception - any error.

ClusterLinkService

public ClusterLinkService(java.lang.String thisPassword,
                  java.lang.String thisAdminKey)
                   throws java.lang.Exception

Creates a new instance of ClusterLinkService.

Parameters:

thisPassword - the component password.

thisAdminKey - the unique service key.

Throws:

java.lang.Exception - any error.

ClusterLinkService

public ClusterLinkService(java.lang.String thisPassword,
                  java.lang.String thisAdminKey,
                  org.licas_xml.abs.Element adminXml)
                   throws java.lang.Exception

Creates a new instance of ClusterLinkService.

Parameters:

thisPassword - the component password.

thisAdminKey - the unique service key.

adminXml - the admin info or description of this service.

Throws:

java.lang.Exception - any error.

Method Detail

resetValues

public void resetValues()

Reset variables for another test run.

Specified by:

resetValues in interface org.licas.def.evaluate.DataServiceDef

Overrides:

resetValues in class org.licas.service.sci.DataService

iterationsOK

protected boolean iterationsOK(int maxIterations)

Return true if the current iterations value is OK with respect to a maximum value. This also updates the iterations value.

Parameters:

maxIterations - the maximum value to compare with.

Returns:

true if the current value is OK.

alreadyLinkedTo

protected int alreadyLinkedTo(java.lang.String linkTo)
                       throws org.licas.util.exception.ServiceException,
                              java.lang.Exception

Check for existing links to the selected service, as part of a cluster.

Parameters:

linkTo - the uuid of the service to check for.

Returns:

an integer of -1 if the service does not yet exist, 0 if there is no link to the service or its cluster, or 1 if there is a link to the service or its cluster.

Throws:

org.licas.util.exception.ServiceException - service not found error.

java.lang.Exception - any error.

getMetricType

protected java.lang.String getMetricType()

Get the evaluation metric type, if initialised with the info in the admin Meta element. This check can be performed automatically, but the metric info might not be added, when a default metric (Euclidean) can be used instead.

Returns:

the evaluation metric type, if added to the admin document Meta element, or null otherwise.