Package org.intermine.webservice.server.widget

Class AvailableWidgetsService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.widget.AvailableWidgetsService

public class AvailableWidgetsService
extends JSONService

A service for listing the available widgets.

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

Method Summary

Modifier and Type	Method	Description
protected void	execute()	Runs service.
protected java.util.Map<java.lang.String,java.lang.Object>	getHeaderAttributes()	Get the header attributes to apply to the formatter.
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, getResultsKey, lazyList, postInit

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

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

AvailableWidgetsService

public AvailableWidgetsService(InterMineAPI im)

Constructor

Parameters:

im - The InterMine application object.

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

Throws:

java.lang.Exception - if some error occurs

getHeaderAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getHeaderAttributes()

Description copied from class: JSONService

Get the header attributes to apply to the formatter.

Overrides:

getHeaderAttributes in class JSONService

Returns:

A map from string to object.

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.