Package org.intermine.webservice.server.query

Class QueryListAppendService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.query.AbstractQueryService

org.intermine.webservice.server.query.QueryToListService

org.intermine.webservice.server.query.QueryListAppendService

public class QueryListAppendService
extends QueryToListService

Append items to a list from the results of a query.

Author:

Alex Kalderimis

Field Summary

Fields inherited from class org.intermine.webservice.server.query.QueryToListService

bagManager

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

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

Constructor Summary

Constructors

Constructor	Description
QueryListAppendService(InterMineAPI api)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	generateListFromQuery(PathQuery pq, ListInput input, Profile profile)	Generate a list from a pathquery.
protected InterMineBag	getList(Profile profile, java.lang.String name)	Get a list from a profile, throwing a service forbidden exception if the list is not accessible.

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

canServe, execute, getDefaultFormat, getQuery, getQuery, setHeaderAttributes, validateState

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

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryListAppendService

public QueryListAppendService(InterMineAPI api)

Constructor.

Parameters:

api - A reference to the InterMine settings bundle.

Method Detail

generateListFromQuery

protected void generateListFromQuery(PathQuery pq,
                                     ListInput input,
                                     Profile profile)
                              throws ObjectStoreException,
                                     PathException

Description copied from class: QueryToListService

Generate a list from a pathquery.

Overrides:

generateListFromQuery in class QueryToListService

Parameters:

pq - The pathquery

input - The input

profile - The profile the list should belong to

Throws:

ObjectStoreException - If there is an issue running the queries that generate the list.

PathException - If the paths supplied are illegal.

getList

protected InterMineBag getList(Profile profile,
                               java.lang.String name)

Get a list from a profile, throwing a service forbidden exception if the list is not accessible.

Parameters:

profile - The profile the list is expected to be in.

name - The name of the list.

Returns:

The list.