Class JaccardIndexService
- java.lang.Object
-
- org.intermine.webservice.server.WebService
-
- org.intermine.webservice.server.lists.JaccardIndexService
-
public class JaccardIndexService extends WebService
A service to compare the given list to all other available lists using the Jaccard Index- Author:
- Julie Sullivan
-
-
Field Summary
-
Fields inherited from class org.intermine.webservice.server.WebService
dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties
-
-
Constructor Summary
Constructors Constructor Description JaccardIndexService(InterMineAPI im)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canServe(Format format)
Check whether the format is acceptable.protected void
execute()
Runs service.protected Format
getDefaultFormat()
protected java.util.Map<java.lang.String,InterMineBag>
getLists()
Get the lists for this request.-
Methods inherited from class org.intermine.webservice.server.WebService
cleanUp, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultFileName, getDefaultOutput, getDefaultOutput, getExtension, getFormat, getIntParameter, getIntParameter, getLineBreak, getListManager, getOptionalParameter, getOptionalParameter, getPermission, getProperty, getRawOutput, getRequestFileName, getRequiredParameter, hasCallback, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, postInit, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage
-
-
-
-
Constructor Detail
-
JaccardIndexService
public JaccardIndexService(InterMineAPI im)
Constructor- Parameters:
im
- A reference to the InterMine API settings bundle
-
-
Method Detail
-
execute
protected void execute() throws java.lang.Exception
Description copied from class:WebService
Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.- Specified by:
execute
in classWebService
- Throws:
java.lang.Exception
- if some error occurs
-
getLists
protected java.util.Map<java.lang.String,InterMineBag> getLists()
Get the lists for this request.- Returns:
- The lists that are available.
-
getDefaultFormat
protected Format getDefaultFormat()
- Overrides:
getDefaultFormat
in classWebService
- Returns:
- The default format constant for this service.
-
canServe
protected boolean canServe(Format format)
Description copied from class:WebService
Check whether the format is acceptable. By default returns true. Services with a particular set of accepted formats should override this and check.- Overrides:
canServe
in classWebService
- Parameters:
format
- The format to check.- Returns:
- whether or not this format is acceptable.
-
-