Package org.intermine.webservice.server.widget

Class EnrichmentWidgetResultService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.widget.WidgetService

org.intermine.webservice.server.widget.EnrichmentWidgetResultService

public class EnrichmentWidgetResultService
extends WidgetService

Web service that returns the result of an enrichment calculation over a list of objects. WidgetsRequestProcessor for parameter description

Author:

Alex Kalderimis, Xavier Watkins, Daniela Butano

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

Method Summary

Modifier and Type	Method	Description
protected void	addOutputConfig(WidgetConfig config)	Add metadata about the widget we are using.
protected boolean	canServe(Format format)	Check whether the format is acceptable.
protected void	execute()	Executes service specific logic.
protected WidgetResultProcessor	getProcessor()
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.widget.WidgetService

addOutputAttribute, addOutputFilter, addOutputIdsInfo, addOutputListInfo, addOutputResult, getDefaultFilterValue, getHeaderAttributes, retrieveBag

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

addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, getResultsKey, 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

EnrichmentWidgetResultService

public EnrichmentWidgetResultService(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.

execute

protected void execute()
                throws java.lang.Exception

Executes service specific logic.

Specified by:

execute in class WebService

Throws:

java.lang.Exception - an error has occurred

addOutputConfig

protected void addOutputConfig(WidgetConfig config)

Description copied from class: WidgetService

Add metadata about the widget we are using.

Overrides:

addOutputConfig in class WidgetService

Parameters:

config - The description of the widget.

getProcessor

protected WidgetResultProcessor getProcessor()

Specified by:

getProcessor in class WidgetService

Returns:

A WidgetResultProcessor of some type, capable of serializing the output.

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.