Package org.intermine.web.logic.widget.config

Class GraphWidgetConfig

  • public class GraphWidgetConfig
extends WidgetConfig
    Configuration object describing details of a graph displayer
    Author:
    Xavier Watkins

    • Constructor Detail

      • GraphWidgetConfig

        public GraphWidgetConfig()

    • Method Detail

      • getSession

        public javax.servlet.http.HttpSession getSession()
        Get the session
        Returns:
        the session

      • setSession

        public void setSession​(javax.servlet.http.HttpSession session)
        Parameters:
        session - the session to set

      • getDomainLabel

        public java.lang.String getDomainLabel()
        Get the domainLabel
        Returns:
        the domainLabel

      • setDomainLabel

        public void setDomainLabel​(java.lang.String domainLabel)
        Set the value of domainLabel
        Parameters:
        domainLabel - a String

      • getRangeLabel

        public java.lang.String getRangeLabel()
        Get the value of rangeLabel
        Returns:
        the rangeLabel

      • setRangeLabel

        public void setRangeLabel​(java.lang.String rangeLabel)
        Set the value of rangeLabel
        Parameters:
        rangeLabel - a String

      • setGraphType

        public void setGraphType​(java.lang.String graphType)
        Parameters:
        graphType - type of graph, e.g. BarChart, StackedBarChart

      • getGraphType

        public java.lang.String getGraphType()
        Get the type of this graph, e.g. BarChart, StackedBarChart
        Returns:
        the type of this graph

      • toString

        public java.lang.String toString()
        Return an XML String of this Type object
        Overrides:
        toString in class java.lang.Object
        Returns:
        a String version of this WebConfig object

      • getBagType

        public java.lang.String getBagType()
        Returns:
        the supported bag-types

      • setBagType

        public void setBagType​(java.lang.String bagType)
        Parameters:
        bagType - The bag types this widget supports

      • getListPath

        public java.lang.String getListPath()
        Returns:
        The list path

      • setListPath

        public void setListPath​(java.lang.String bagPath)
        Parameters:
        bagPath - the new value for the list path

      • isListPathSet

        public boolean isListPathSet()
        Returns:
        whether this the list path has a value.

      • getCategoryPath

        public java.lang.String getCategoryPath()
        Returns:
        the category path

      • setCategoryPath

        public void setCategoryPath​(java.lang.String categoryPath)
        Parameters:
        categoryPath - the path that defines the category we are charting

      • getSeriesPath

        public java.lang.String getSeriesPath()
        Returns:
        the series path

      • setSeriesPath

        public void setSeriesPath​(java.lang.String seriesPath)
        Parameters:
        seriesPath - the new value of the series path.

      • comparesActualToExpected

        public boolean comparesActualToExpected()
        Returns:
        whether this chart widget compares actual and expected values.

      • hasSeries

        public boolean hasSeries()
        Returns:
        whether the widget has a series.

      • getSeriesValues

        public java.lang.String getSeriesValues()
        Returns:
        the series values

      • setSeriesValues

        public void setSeriesValues​(java.lang.String seriesValues)
        Parameters:
        seriesValues - the values of the series axis.

      • getSeriesLabels

        public java.lang.String getSeriesLabels()
        Returns:
        the labels for the series.

      • setSeriesLabels

        public void setSeriesLabels​(java.lang.String seriesLabels)
        Parameters:
        seriesLabels - The labels for the series.

      • geteditable

        public java.lang.String geteditable()
        Returns:
        the editable attribute

      • seteditable

        public void seteditable​(java.lang.String editable)
        Parameters:
        editable - editable

      • getExtraAttributes

        public java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getExtraAttributes​(InterMineBag imBag,
                                                                                                       ObjectStore os)
                                                                                                throws java.lang.Exception
        Specified by:
        getExtraAttributes in class WidgetConfig
        Parameters:
        imBag - the InterMineBag
        os - the ObjectStore
        Returns:
        the getExtraAttributes
        Throws:
        java.lang.Exception - if something goes wrong

      • getWidget

        public GraphWidget getWidget​(InterMineBag imBag,
                             InterMineBag populationBag,
                             ObjectStore os,
                             WidgetOptions options,
                             java.lang.String ids,
                             java.lang.String populationIds)
        Specified by:
        getWidget in class WidgetConfig
        Parameters:
        imBag - the bag for this widget
        populationBag - the population bag
        os - The objectstore where all the data is.
        options - the options for this widget.
        ids - list of IDs to analyse, use instead of intermine bag
        populationIds - use instead of populationBag
        Returns:
        the widget