Package org.intermine.web.logic.config

Class ReportDisplayerConfig

  • public class ReportDisplayerConfig
extends java.lang.Object
    Bean to hold configuration for report displayers. One instance of this class represents a single report page displayer.
    Author:
    Richard Smith

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> getConfiguredTypes()
      Get the unqualified class names for which this displayer should be displayed.
      java.lang.String getJavaClass()
      Get the Java class name of the controller for this displayer.
      java.lang.String getJspName()
      Get the name of the JSP associated with this displayer.
      org.json.JSONObject getParameterJson()
      Get the parameters for this displayer as a JSONObject
      java.lang.String getParameterString()
      A JSON string representing custom parameters for this displayer.
      java.lang.String getPlacement()
      Get the data category name under which this displayer should appear.
      java.util.Set<java.lang.String> getReplacedFieldNames()
      Get the names of fields this displayer replaces.
      java.lang.String getReplacesFields()
      Get the comma separated list of field names that should not be displayed on the report page when this displayer is used.
      java.lang.Boolean getShowImmediately()
      Should we display this 'splayer immediately, wo/ waiting for the AJAX call?
      java.lang.String getTypes()
      Get the comma separated unqualified class names for which this displayer should be displayed.
      void setJavaClass​(java.lang.String javaClass)
      Set the Java class name of the controller for this displayer.
      void setJspName​(java.lang.String jspName)
      Set the name of the JSP associated with this displayer.
      void setParameters​(java.lang.String parameters)
      A JSON string representing custom parameters for this displayer.
      void setPlacement​(java.lang.String placement)
      Set the data category name under which this displayer should appear.
      void setReplacesFields​(java.lang.String replacesFields)
      Set the comma separated list of field names that should not be displayed on the report page when this displayer is used.
      void setShowImmediately​(java.lang.Boolean showImmediately)
      Set if we should display the displayer immediately
      void setTypes​(java.lang.String types)
      Set the types this displayer should be used for as a comma separated list of unqualified class names.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReportDisplayerConfig

        public ReportDisplayerConfig()

    • Method Detail

      • getTypes

        public java.lang.String getTypes()
        Get the comma separated unqualified class names for which this displayer should be displayed. Provides direct access to the value provided in the config file.
        Returns:
        a comma separated list of unqualified class names

      • setTypes

        public void setTypes​(java.lang.String types)
        Set the types this displayer should be used for as a comma separated list of unqualified class names.
        Parameters:
        types - a comma separated list of unqualified class names

      • getConfiguredTypes

        public java.util.Set<java.lang.String> getConfiguredTypes()
        Get the unqualified class names for which this displayer should be displayed. This returns splits values listed in the webconfig-model.xml, inheritance is handled elsewhere.
        Returns:
        unqualified class names

      • getJavaClass

        public java.lang.String getJavaClass()
        Get the Java class name of the controller for this displayer.
        Returns:
        a fully qualified java class name

      • setJavaClass

        public void setJavaClass​(java.lang.String javaClass)
        Set the Java class name of the controller for this displayer.
        Parameters:
        javaClass - a fully qualified java class name

      • getJspName

        public java.lang.String getJspName()
        Get the name of the JSP associated with this displayer.
        Returns:
        The name of the JSP associated with this displayer

      • setJspName

        public void setJspName​(java.lang.String jspName)
        Set the name of the JSP associated with this displayer.
        Parameters:
        jspName - the name of the JSP

      • getPlacement

        public java.lang.String getPlacement()
        Get the data category name under which this displayer should appear.
        Returns:
        a data category name

      • setPlacement

        public void setPlacement​(java.lang.String placement)
        Set the data category name under which this displayer should appear.
        Parameters:
        placement - a data category name

      • getParameterString

        public java.lang.String getParameterString()
        A JSON string representing custom parameters for this displayer. Anything can be specified in the parameters, the controller for the displayer needs to read and handle them.
        Returns:
        parameters the JSON string with custom parameters from the config file

      • getParameterJson

        public org.json.JSONObject getParameterJson()
        Get the parameters for this displayer as a JSONObject
        Returns:
        The parameters as a JSONObject
        Throws:
        java.lang.RuntimeException - if the parameter string does not parse into JSON

      • setParameters

        public void setParameters​(java.lang.String parameters)
        A JSON string representing custom parameters for this displayer. Anything can be specified in the parameters, the controller for the displayer needs to read and handle them.
        Parameters:
        parameters - a JSON string with custom parameters

      • getReplacesFields

        public java.lang.String getReplacesFields()
        Get the comma separated list of field names that should not be displayed on the report page when this displayer is used. May be an empty string.
        Returns:
        a comma separated list of field names

      • setReplacesFields

        public void setReplacesFields​(java.lang.String replacesFields)
        Set the comma separated list of field names that should not be displayed on the report page when this displayer is used. May be an empty string.
        Parameters:
        replacesFields - a comma separated list of field names

      • getShowImmediately

        public java.lang.Boolean getShowImmediately()
        Should we display this 'splayer immediately, wo/ waiting for the AJAX call?
        Returns:
        true if we should display immediately

      • setShowImmediately

        public void setShowImmediately​(java.lang.Boolean showImmediately)
        Set if we should display the displayer immediately
        Parameters:
        showImmediately - sets whether to display immediately or not

      • getReplacedFieldNames

        public java.util.Set<java.lang.String> getReplacedFieldNames()
        Get the names of fields this displayer replaces.
        Returns:
        a set of names for all fields of this class that no longer need displaying.