Package org.intermine.web.logic.bag

Class BagConverter

  • public abstract class BagConverter
extends java.lang.Object
    Author:
    "Xavier Watkins"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract org.apache.struts.action.ActionMessage getActionMessage​(java.lang.String externalids, int convertedSize, java.lang.String type, java.lang.String parameters)
      Get the ActionMessage to display in the webapp
      abstract java.util.List<java.lang.Integer> getConvertedObjectIds​(Profile profile, java.lang.String bagType, java.util.List<java.lang.Integer> bagList, java.lang.String constraintValue)  
      abstract java.util.Map<java.lang.String,​java.lang.String> getCounts​(Profile profile, InterMineBag bag)
      Method to return list of values and the counts of converted objects for that object used for display on list analysis page.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BagConverter

        public BagConverter​(InterMineAPI im,
                    WebConfig webConfig)
        Parameters:
        im - intermine API
        webConfig - the webconfig

    • Method Detail

      • getActionMessage

        public abstract org.apache.struts.action.ActionMessage getActionMessage​(java.lang.String externalids,
                                                                        int convertedSize,
                                                                        java.lang.String type,
                                                                        java.lang.String parameters)
                                                                 throws ObjectStoreException,
                                                                        java.io.UnsupportedEncodingException
        Get the ActionMessage to display in the webapp
        Parameters:
        externalids - the initial ids as a comma separated list
        parameters - the parameters
        convertedSize - the converted size
        type - the type
        Returns:
        an ActionMessage
        Throws:
        ObjectStoreException - exception
        java.io.UnsupportedEncodingException - exception

      • getConvertedObjectIds

        public abstract java.util.List<java.lang.Integer> getConvertedObjectIds​(Profile profile,
                                                                        java.lang.String bagType,
                                                                        java.util.List<java.lang.Integer> bagList,
                                                                        java.lang.String constraintValue)
                                                                 throws ObjectStoreException
        Parameters:
        profile - user's profile
        bagType - class of list
        bagList - list of intermine object IDs
        constraintValue - value of constraint
        Returns:
        list of intermine IDs
        Throws:
        ObjectStoreException - if we have issues querying the db.

      • getCounts

        public abstract java.util.Map<java.lang.String,​java.lang.String> getCounts​(Profile profile,
                                                                                 InterMineBag bag)
                                                                          throws ObjectStoreException
        Method to return list of values and the counts of converted objects for that object used for display on list analysis page.
        Parameters:
        bag - intermine bag
        profile - user profile
        Returns:
        map of values to counts
        Throws:
        ObjectStoreException - if we have issues querying the db.