Package org.intermine.webservice.server.query

Class QueryRetrieverService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.query.QueryRetrieverService

public class QueryRetrieverService
extends WebService

A service that retrieves a stored query by qid. queries.

Author:

Alex Kalderimis

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
QueryRetrieverService(InterMineAPI im)

Method Summary

Modifier and Type	Method	Description
protected boolean	canServe(Format format)	Check whether the format is acceptable.
protected void	execute()	Runs service.
protected java.lang.String	getDefaultFileName()
protected Format	getDefaultFormat()
protected void	postInit()	Subclasses can hook in here to do common behaviour that needs to happen after initialisation.

Methods inherited from class org.intermine.webservice.server.WebService

cleanUp, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultOutput, getDefaultOutput, getExtension, getFormat, getIntParameter, getIntParameter, getLineBreak, getListManager, getOptionalParameter, getOptionalParameter, getPermission, getProperty, getRawOutput, getRequestFileName, getRequiredParameter, hasCallback, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryRetrieverService

public QueryRetrieverService(InterMineAPI im)

Parameters:

im - The InterMine state object

Method Detail

getDefaultFormat

protected Format getDefaultFormat()

Overrides:

getDefaultFormat in class WebService

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 class WebService

Parameters:

format - The format to check.

Returns:

whether or not this format is acceptable.

getDefaultFileName

protected java.lang.String getDefaultFileName()

Overrides:

getDefaultFileName in class WebService

Returns:

The default file name for this service. (default = "result.tsv")

postInit

protected void postInit()

Description copied from class: WebService

Subclasses can hook in here to do common behaviour that needs to happen after initialisation.

Overrides:

postInit in class WebService

execute

protected void execute()

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 class WebService