org.intermine.webservice.server.query.result
Class WebServiceRequestParser

java.lang.Object
  org.intermine.webservice.server.query.result.WebServiceRequestParser

Direct Known Subclasses:

QueryResultRequestParser, TemplateResultRequestParser

public class WebServiceRequestParser
extends java.lang.Object

Base request parser that is used by advanced web service parsers.

Field Summary

static java.lang.String	FORMAT_PARAMETER_CSV Value of parameter when user wants comma separated output to be returned.
static java.lang.String	FORMAT_PARAMETER_HTML Value of parameter when user wants html output to be returned.
static java.lang.String	FORMAT_PARAMETER_TAB Value of parameter when user wants tab separated output to be returned.
static java.lang.String	FORMAT_PARAMETER_XML Value of parameter when user wants xml output to be returned.
static java.lang.String	LIMIT_PARAMETER Name of size parameter that determines number of returned results.
static java.lang.String	OUTPUT_PARAMETER Name of format parameter that specifies format of returned results.
static java.lang.String	START_PARAMETER Name of start parameter that determines index of first returned result.

Constructor Summary

WebServiceRequestParser()

Method Summary

void	parseRequest(javax.servlet.http.HttpServletRequest request, WebServiceInput input) Parses common parameters for all web services.

Methods inherited from class java.lang.Object

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

Field Detail

START_PARAMETER

public static final java.lang.String START_PARAMETER

Name of start parameter that determines index of first returned result.

See Also:

Constant Field Values

LIMIT_PARAMETER

public static final java.lang.String LIMIT_PARAMETER

Name of size parameter that determines number of returned results.

See Also:

Constant Field Values

FORMAT_PARAMETER_XML

public static final java.lang.String FORMAT_PARAMETER_XML

Value of parameter when user wants xml output to be returned.

See Also:

Constant Field Values

FORMAT_PARAMETER_TAB

public static final java.lang.String FORMAT_PARAMETER_TAB

Value of parameter when user wants tab separated output to be returned.

See Also:

Constant Field Values

FORMAT_PARAMETER_HTML

public static final java.lang.String FORMAT_PARAMETER_HTML

Value of parameter when user wants html output to be returned.

See Also:

Constant Field Values

FORMAT_PARAMETER_CSV

public static final java.lang.String FORMAT_PARAMETER_CSV

Value of parameter when user wants comma separated output to be returned.

See Also:

Constant Field Values

OUTPUT_PARAMETER

public static final java.lang.String OUTPUT_PARAMETER

Name of format parameter that specifies format of returned results.

See Also:

Constant Field Values

Constructor Detail

WebServiceRequestParser

public WebServiceRequestParser()

Method Detail

parseRequest

public void parseRequest(javax.servlet.http.HttpServletRequest request,
                         WebServiceInput input)

Parses common parameters for all web services. Must be called from parseRequest method in subclass else the parameters won't be set.

Parameters:

request - request

input - web service input in which the parameters are set