Package org.intermine.webservice.server.template

Class SingleTemplateService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.template.SingleTemplateService

public class SingleTemplateService
extends JSONService

Service that responds with a single template.

Author:

Alex Kalderimis

Field Summary

Fields inherited from class org.intermine.webservice.server.core.JSONService

bagManager, model

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

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

Constructor Summary

Constructors

Constructor	Description
SingleTemplateService(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.
java.lang.String	getResultsKey()
protected Output	makeXMLOutput(java.io.PrintWriter out, java.lang.String separator)	Make the XML output given the HttpResponse's PrintWriter.

Methods inherited from class org.intermine.webservice.server.core.JSONService

addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, getHeaderAttributes, lazyList, postInit

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, 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

SingleTemplateService

public SingleTemplateService(InterMineAPI im)

Parameters:

im - The InterMine state object

Method Detail

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.

makeXMLOutput

protected Output makeXMLOutput(java.io.PrintWriter out,
                               java.lang.String separator)

Description copied from class: WebService

Make the XML output given the HttpResponse's PrintWriter.

Overrides:

makeXMLOutput in class WebService

Parameters:

out - The PrintWriter from the HttpResponse.

separator - the line-separator for the client's platform.

Returns:

An Output that produces good XML.

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

getResultsKey

public java.lang.String getResultsKey()

Overrides:

getResultsKey in class JSONService

Returns:

The key for the results property.