Package org.intermine.webservice.server.lists

Class AvailableListsService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.lists.AvailableListsService

Direct Known Subclasses:

ListsService

public class AvailableListsService
extends WebService

A service to report what lists a user has access to, and some details of those lists.

Author:

Alexis 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
AvailableListsService(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 Format	getDefaultFormat()
protected java.util.Collection<InterMineBag>	getLists()	Get the lists for this request.
protected java.util.Collection<InterMineBag>	getListsMatching(ListManager listManager, java.lang.String nameFilter)	Get the lists that match the current filter.

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

Constructor Detail

AvailableListsService

public AvailableListsService(InterMineAPI im)

Constructor

Parameters:

im - A reference to the InterMine API settings bundle

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

getLists

protected java.util.Collection<InterMineBag> getLists()

Get the lists for this request.

Returns:

The lists that are available.

getListsMatching

protected java.util.Collection<InterMineBag> getListsMatching(ListManager listManager,
                                                              java.lang.String nameFilter)

Get the lists that match the current filter.

Parameters:

listManager - The list manager which has all the lists.

nameFilter - Filter over the names.

Returns:

The lists that match the filter.

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.