Package org.intermine.webservice.server.query

Class CodeService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.query.AbstractQueryService

org.intermine.webservice.server.query.CodeService

public class CodeService
extends AbstractQueryService

A service for generating code based on a query.

Author:

Alex Kalderimis

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.log4j.Logger	LOG

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

dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties

Constructor Summary

Constructors

Constructor	Description
CodeService(InterMineAPI im)	Constructor.

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 java.lang.String	getExtension()
protected static boolean	pathQueryIsPublic(PathQuery pq, InterMineAPI im, Profile p)	Utility function to determine whether the PathQuery is publicly accessible.

Methods inherited from class org.intermine.webservice.server.query.AbstractQueryService

formatIsJsonObj, getQueryBuilder, getSchemaLocation, getSchemaUrl

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

cleanUp, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultOutput, getDefaultOutput, 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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

Constructor Detail

CodeService

public CodeService(InterMineAPI im)

Constructor.

Parameters:

im - The InterMine application 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")

getExtension

protected java.lang.String getExtension()

Overrides:

getExtension in class WebService

Returns:

the file-name extension for the result-set.

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

pathQueryIsPublic

protected static boolean pathQueryIsPublic(PathQuery pq,
                                           InterMineAPI im,
                                           Profile p)

Utility function to determine whether the PathQuery is publicly accessible. PathQueries are accessibly publicly as long as they do not reference private lists.

Parameters:

pq - The query to interrogate

im - A reference to the InterMine API

p - A user's profile

Returns:

whether the query is accessible publicly or not