org.licas.query

Class ServerMetaSearch

java.lang.Object

org.licas.ServiceAdmin

org.licas.query.ServerMetaSearch

All Implemented Interfaces:

ServiceMetaSearchDef

public class ServerMetaSearch
extends ServiceAdmin
implements ServiceMetaSearchDef

Metadata search facility on a server to search for related services. This can search over limited information on the services stored under this server. The search is performed over the metadata stored for each service.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected InformationMediator	infoMediator Can be used to mediate between services or update related values
protected PasswordHandler	passwordHandler The password handler
protected java.util.ArrayList<java.lang.String>	queryIDs List of IDs for queries currently being executed
protected ServiceSpec	serviceSpec Initialisation service specification

Fields inherited from class org.licas.ServiceAdmin

adminInfo, contractManager, keywordHandler, service, serviceAdminKey, services, serviceTypes, workInfo

Constructor Summary

Constructors

Constructor and Description
ServerMetaSearch(Service theParent, PasswordHandler thePasswordHandler) Create a new instance of ServerMetaSearch.

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	metaSearch(java.lang.String queryEngine, int callTimeout, org.licas_xml.abs.Element request, ServiceLinks serverLinks) Allow the server to perform queries over all of the registered service metadata to find matching information.

Methods inherited from class org.licas.ServiceAdmin

clearInstanceValues, createFullServiceMeta, createMetaForRepos, createServiceMeta, getAdminInfo, getContractManager, getInstanceValues, getKeywordHandler, getService, getService, getServiceClasses, getServiceNames, getServiceNames, getServiceNames, getServiceOrWrapper, getServiceType, getServiceTypes, removeAllServices, removeAllServices, removeService, removeService, setAdminInfo, setWorkInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.licas.def.search.ServiceMetaSearchDef

getServiceClasses, getServiceNames, getServiceNames, getServiceTypes

Field Detail

queryIDs

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

List of IDs for queries currently being executed

passwordHandler

protected PasswordHandler passwordHandler

The password handler

serviceSpec

protected ServiceSpec serviceSpec

Initialisation service specification

infoMediator

protected InformationMediator infoMediator

Can be used to mediate between services or update related values

Constructor Detail

ServerMetaSearch

public ServerMetaSearch(Service theParent,
                        PasswordHandler thePasswordHandler)
                 throws java.lang.Exception

Create a new instance of ServerMetaSearch.

Parameters:

theParent - the parent service.

thePasswordHandler - the parent password handler.

Throws:

java.lang.Exception - any error.

Method Detail

metaSearch

public org.licas_xml.abs.Element metaSearch(java.lang.String queryEngine,
                                            int callTimeout,
                                            org.licas_xml.abs.Element request,
                                            ServiceLinks serverLinks)
                                     throws java.lang.Exception

Allow the server to perform queries over all of the registered service metadata to find matching information. To be recognised by the default classes, the root request element should have the tag name of QueryConst.QUERYMODEL, or 'Query_Model'. This should then contain a description of the query request. For this default model, the XML request that is passed in needs to be parsed by a QueryParser parser into a QueryModel object, of the 'licas_text' package. This is what the default classes will then evaluate. The documentation describes the different fields in more detail.

Specified by:

metaSearch in interface ServiceMetaSearchDef

Parameters:

queryEngine - the query engine type. Required for a distributed query.

callTimeout - maximum time allowed for the call (in milliseconds).

request - the query request.

serverLinks - for links with other servers. These will also be queried.

Returns:

any suitable matches to the request. These are stored inside of an element for each related service, with attributes to describe the service uuid and type.

Throws:

java.lang.Exception - any error.