Package org.intermine.webservice.server.widget

Class WidgetsServiceInput

java.lang.Object

org.intermine.webservice.server.widget.WidgetsServiceInput

All Implemented Interfaces:

EnrichmentOptions, WidgetOptions

Direct Known Subclasses:

WidgetsServiceInput.Builder

public class WidgetsServiceInput
extends java.lang.Object
implements EnrichmentOptions

WidgetsServiceInput is parameter object representing parameters for the WidgetsService web service. This class is read-only, containing only getters.

Author:

"Xavier Watkins", Daniela Butano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WidgetsServiceInput.Builder	Class to build Inputs for the Widget Service.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	bagName
protected java.lang.String	correction
protected java.lang.String	extraAttribute
protected java.lang.String	filter
protected java.lang.String	ids
protected double	maxP
protected java.lang.String	populationBagName
protected java.lang.String	populationIds
protected boolean	savePopulation
protected java.lang.String	widgetId

Constructor Summary

Constructors

Constructor	Description
WidgetsServiceInput()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBagName()	Get the name of the bag
java.lang.String	getCorrection()
java.lang.String	getExtraAttribute()
java.lang.String	getExtraCorrectionCoefficient()
java.lang.String	getFilter()
java.lang.String	getIds()
double	getMaxPValue()
java.lang.String	getPopulationBagName()	Get the bag's name for reference population
java.lang.String	getPopulationIds()
java.lang.String	getWidgetId()	Get the name or id of the widget
boolean	shouldSavePopulation()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

widgetId

protected java.lang.String widgetId

bagName

protected java.lang.String bagName

populationBagName

protected java.lang.String populationBagName

savePopulation

protected boolean savePopulation

filter

protected java.lang.String filter

maxP

protected double maxP

correction

protected java.lang.String correction

extraAttribute

protected java.lang.String extraAttribute

ids

protected java.lang.String ids

populationIds

protected java.lang.String populationIds

Constructor Detail

WidgetsServiceInput

public WidgetsServiceInput()

Method Detail

getWidgetId

public java.lang.String getWidgetId()

Get the name or id of the widget

Returns:

the widgetName

getBagName

public java.lang.String getBagName()

Get the name of the bag

Returns:

the bagName

getPopulationBagName

public java.lang.String getPopulationBagName()

Get the bag's name for reference population

Returns:

the bagName

shouldSavePopulation

public boolean shouldSavePopulation()

Returns:

whether we should save the population list.

getIds

public java.lang.String getIds()

Returns:

list of intermine object IDs to analyse

getPopulationIds

public java.lang.String getPopulationIds()

Returns:

list of intermine object IDs to analyse instead of populationBagName

getFilter

public java.lang.String getFilter()

Specified by:

getFilter in interface WidgetOptions

Returns:

the filter

getMaxPValue

public double getMaxPValue()

Specified by:

getMaxPValue in interface EnrichmentOptions

Returns:

the maximum acceptable p-value. (a value between 0 - 1)

getCorrection

public java.lang.String getCorrection()

Specified by:

getCorrection in interface EnrichmentOptions

Returns:

the correction algorithm to be used, eg. Holm-Bonferroni.

getExtraAttribute

public java.lang.String getExtraAttribute()

Returns:

any other extra attribute

getExtraCorrectionCoefficient

public java.lang.String getExtraCorrectionCoefficient()

Specified by:

getExtraCorrectionCoefficient in interface EnrichmentOptions

Returns:

the extra correction coefficient

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object