Suggestion Server

The suggestion server is an XML-RPC interface into the search functionality of the Vocabulary Explorer, although only a limited subset of the functionality is available.

The service is available from:
http://explicator.dcs.gla.ac.uk/VocabularyService/xmlrpc
and can be called in the following way
VocabularySearch.methodName
The list of available methods is available below.

Function calls
Sample Client

XML-RPC Functions

Method Summary
`Array<String>`	`findConcepts(String searchTerms)` Find the URIs for the concepts that match a given search term
`int`	`findResultSize(String searchTerms)` Find the size of the result set that would be returned for a particular search term
`Array<String>`	`findTopKConcepts(String searchTerms, int maxSize)` Find the URIs of the top ranked concepts that match a given search term, up to some limit given by maxSize.
`Array<Array<String>>`	`getPrefLabels(String conceptURI)` Returns the preferred labels for a given concept URI

Method Detail

getPrefLabels

Array<Array<String>> getPrefLabels(String conceptURI)
                                   throws Exception

Returns the preferred labels for a given concept URI

Parameters:: conceptURI -
Returns:
Throws:: Exception

findResultSize

int findResultSize(String searchTerms)
                   throws Exception

Find the size of the result set that would be returned for a particular search term

Parameters:: searchTerms -
Returns:
Throws:: Exception

findTopKConcepts

Array<String> findTopKConcepts(String searchTerms,
                               int maxSize)
                               throws Exception

Find the URIs of the top ranked concepts that match a given search term, up to some limit given by maxSize. If the search does not find enough documents then a smaller result set is returned.

Parameters:: searchTerms - terms to be searched for; maxSize - maximum size of result set, could be smaller if not enough concepts match
Returns:
Throws:: Exception

findConcepts

Array<String> findConcepts(String searchTerms)
                           throws Exception

Find the URIs for the concepts that match a given search term

Parameters:: searchTerms -
Returns:
Throws:: Exception

Sample Java Client

A java client for interacting with the XML-RPC server is available from here. It takes the search string as a command line argument.

The client makes use of the apache implementation of XML-RPC support libraries which are available from here.

Explicator