Package org.intermine.webservice.server.core

Class ListManager

  • All Implemented Interfaces:
    Producer<java.util.Map<java.lang.String,​InterMineBag>>
    public class ListManager
extends java.lang.Object
implements Producer<java.util.Map<java.lang.String,​InterMineBag>>
    Manager of public lists used by web service.
    Author:
    Jakub Kulaviak

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​InterMineBag> getListMap()
      Returns the lists available to the current user in a Map.
      java.util.Collection<InterMineBag> getLists()
      Returns the lists available to the current user.
      java.util.Collection<InterMineBag> getListsContaining​(java.lang.Integer objectId)
      Returns the current lists available to the current user which contain the specified object.
      java.util.List<java.lang.String> getListsNames​(java.lang.Integer objectId)
      Returns public current lists that contain object with specified id.
      boolean isAnyBagUnresolvable()
      Return true if there is at least one bag in the 'to_upgrade' state.
      java.util.Map<java.lang.String,​InterMineBag> produce()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ListManager

        public ListManager​(InterMineAPI im,
                   Profile profile)
        ListManager constructor.
        Parameters:
        im - The InterMine state object
        profile - The current user's profile.

    • Method Detail

      • getListsNames

        public java.util.List<java.lang.String> getListsNames​(java.lang.Integer objectId)
        Returns public current lists that contain object with specified id.
        Parameters:
        objectId - object id
        Returns:
        A list of list names

      • getLists

        public java.util.Collection<InterMineBag> getLists()
        Returns the lists available to the current user.
        Returns:
        A collection of lists the current user can access.

      • getListMap

        public java.util.Map<java.lang.String,​InterMineBag> getListMap()
        Returns the lists available to the current user in a Map.
        Returns:
        An unmodifiable map from list name to list.

      • isAnyBagUnresolvable

        public boolean isAnyBagUnresolvable()
        Return true if there is at least one bag in the 'to_upgrade' state.
        Returns:
        true if there are any bags to upgrade

      • getListsContaining

        public java.util.Collection<InterMineBag> getListsContaining​(java.lang.Integer objectId)
        Returns the current lists available to the current user which contain the specified object.
        Parameters:
        objectId - the id of an InterMineObject to look up
        Returns:
        A collection of lists.

      • produce

        public java.util.Map<java.lang.String,​InterMineBag> produce()
        Specified by:
        produce in interface Producer<java.util.Map<java.lang.String,​InterMineBag>>
        Returns:
        A T of some kind.