Package org.intermine.webservice.server.path

Class PossibleValuesService

  • public class PossibleValuesService
extends JSONService
    A service for retrieving the possible values for a path in the data model.
    Author:
    Alex Kalderimis

    • Constructor Detail

      • PossibleValuesService

        public PossibleValuesService​(InterMineAPI im)
        A service for providing column summary information. This information is designed to be used in forms that provide autocomplete or drop-down options to suggest possible values. It expects a path (such as Employee.name, or CEO.company.departments.employees.name), and lists all possible values that path may represent, along with their frequency. The values list is sorted by the value, not the frequency.
        Parameters:
        im - A reference to the InterMine API bundle.

    • Method Detail

      • canServe

        protected boolean canServe​(Format format)
        Description copied from class: WebService
        Check whether the format is acceptable. By default returns true. Services with a particular set of accepted formats should override this and check.
        Overrides:
        canServe in class WebService
        Parameters:
        format - The format to check.
        Returns:
        whether or not this format is acceptable.

      • initState

        protected void initState()
        Description copied from class: WebService
        Subclasses can put initialisation here.
        Overrides:
        initState in class WebService

      • getHeaderAttributes

        protected java.util.Map<java.lang.String,​java.lang.Object> getHeaderAttributes()
        Description copied from class: JSONService
        Get the header attributes to apply to the formatter.
        Overrides:
        getHeaderAttributes in class JSONService
        Returns:
        A map from string to object.

      • postInit

        protected void postInit()
        Description copied from class: WebService
        Subclasses can hook in here to do common behaviour that needs to happen after initialisation.
        Overrides:
        postInit in class JSONService

      • execute

        protected void execute()
                throws java.lang.Exception
        Description copied from class: WebService
        Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.
        Specified by:
        execute in class WebService
        Throws:
        java.lang.Exception - if some error occurs