Class EnrichmentWidgetConfig
- java.lang.Object
-
- org.intermine.web.logic.widget.config.WidgetConfig
-
- org.intermine.web.logic.widget.config.EnrichmentWidgetConfig
-
public class EnrichmentWidgetConfig extends WidgetConfig
A description of an enrichment calculation. An enrichment calculation analyses a relationship between two items and provides a measure of relevance (a P-Value). an example enrichment widget config stanza looks like this:<enrichmentwidgetdisplayer id="colleague_enrichment" title="Colleague Enrichment" label="Colleague" description="The relationship between employees and their colleagues" startClass="Employee" startClassDisplay="name" enrich="department.employees.id" enrichIdentifier="department.employees.name" typeClass="Employee" views="name, age, department.name"/>
- Author:
- Julie Sullivan, Daniela Butano
-
-
Constructor Summary
Constructors Constructor Description EnrichmentWidgetConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCorrectionCoefficient()
java.lang.String
getEnrich()
The enrich property is the path to the value that should be enriched.java.lang.String
getEnrichIdentifier()
java.lang.String
getExternalLink()
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>
getExtraAttributes(InterMineBag imBag, ObjectStore os)
java.lang.String
getLabel()
java.util.List<PathConstraint>
getPathConstraintsForView()
java.lang.String
getStartClassDisplay()
EnrichmentWidget
getWidget(InterMineBag imBag, InterMineBag populationBag, ObjectStore os, WidgetOptions options, java.lang.String ids, java.lang.String populationIds)
void
setConstraintsForView(java.lang.String constraints)
void
setCorrectionCoefficient(java.lang.String correctionCoefficient)
void
setEnrich(java.lang.String enrich)
void
setEnrichIdentifier(java.lang.String enrichIdentifier)
void
setExternalLink(java.lang.String externalLink)
void
setLabel(java.lang.String label)
void
setStartClassDisplay(java.lang.String startClassDisplay)
java.lang.String
toString()
Return an XML String of this Type object-
Methods inherited from class org.intermine.web.logic.widget.config.WidgetConfig
getDescription, getFilterLabel, getFilters, getFiltersValues, getId, getPathConstraints, getStartClass, getTitle, getTypeClass, getViews, setConstraints, setDescription, setFilterLabel, setFilters, setId, setPathConstraints, setStartClass, setTitle, setTypeClass, setViews
-
-
-
-
Method Detail
-
getLabel
public java.lang.String getLabel()
- Returns:
- the label
-
setLabel
public void setLabel(java.lang.String label)
- Parameters:
label
- the label to set
-
toString
public java.lang.String toString()
Return an XML String of this Type object- Overrides:
toString
in classjava.lang.Object
- Returns:
- a String version of this WebConfig object
-
getExtraAttributes
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getExtraAttributes(InterMineBag imBag, ObjectStore os)
- Specified by:
getExtraAttributes
in classWidgetConfig
- Parameters:
imBag
- the InterMineBagos
- the ObjectStore- Returns:
- the getExtraAttributes
-
getEnrich
public java.lang.String getEnrich()
The enrich property is the path to the value that should be enriched.- Returns:
- the value of the 'enrich' property
-
setEnrich
public void setEnrich(java.lang.String enrich)
- Parameters:
enrich
- the value we should enrich.
-
getEnrichIdentifier
public java.lang.String getEnrichIdentifier()
- Returns:
- the identifier which should be shown to users for each enriched item.
-
setEnrichIdentifier
public void setEnrichIdentifier(java.lang.String enrichIdentifier)
- Parameters:
enrichIdentifier
- The new value of the enriched identifier.
-
getStartClassDisplay
public java.lang.String getStartClassDisplay()
- Returns:
- A display string for the start class.
-
setStartClassDisplay
public void setStartClassDisplay(java.lang.String startClassDisplay)
- Parameters:
startClassDisplay
- the new value of the start class display name.
-
getExternalLink
public java.lang.String getExternalLink()
- Returns:
- the external link for this widget.
-
setExternalLink
public void setExternalLink(java.lang.String externalLink)
- Parameters:
externalLink
- The value of the external link property.
-
setConstraintsForView
public void setConstraintsForView(java.lang.String constraints)
- Parameters:
constraints
- The constraints for the view
-
getPathConstraintsForView
public java.util.List<PathConstraint> getPathConstraintsForView()
- Returns:
- the path constraints for the view.
-
getCorrectionCoefficient
public java.lang.String getCorrectionCoefficient()
- Returns:
- the name of a class that can be used to correct P-Values in the results.
-
setCorrectionCoefficient
public void setCorrectionCoefficient(java.lang.String correctionCoefficient)
- Parameters:
correctionCoefficient
- The name of a class that implements CorrectionCoefficient
-
getWidget
public EnrichmentWidget getWidget(InterMineBag imBag, InterMineBag populationBag, ObjectStore os, WidgetOptions options, java.lang.String ids, java.lang.String populationIds)
- Specified by:
getWidget
in classWidgetConfig
- Parameters:
imBag
- the bag for this widgetpopulationBag
- the population bagos
- The objectstore where all the data is.options
- the options for this widget.ids
- list of IDs to analyse, use instead of intermine bagpopulationIds
- use instead of populationBag- Returns:
- the widget
-
-