Package org.intermine.api.mines

Class FriendlyMineManager

  • public class FriendlyMineManager
extends java.lang.Object
    Class to manage friendly mines
    Author:
    Julie Sullivan, Alex Kalderimis

    • Method Detail

      • getInstance

        public static FriendlyMineManager getInstance​(InterMineAPI api,
                                              java.util.Properties properties)
        Get an instance of FriendlyMineManager. This method caches the instances, keyed against the InterMineAPI they were constructed with. Subsequent invocations will return the same instance, providing that it hasn't already been reaped.
        Parameters:
        api - InterMine api
        properties - the web properties
        Returns:
        an instance of FriendlyMineManager

      • getFriendlyMines

        public java.util.Collection<Mine> getFriendlyMines()
        Return a list of Mines listed in config. Used for intermine links on report pages. This collection does not include the local instance.
        Returns:
        Collection of all friendly mines listed in config

      • getLocalMine

        public Mine getLocalMine()
        Returns:
        the local mine

      • getLinks

        public java.util.Collection<PartnerLink> getLinks​(org.apache.commons.collections.keyvalue.MultiKey key)
        Parameters:
        key - mine + identifier + organism
        Returns:
        homologues for this key combo

      • cacheLinks

        public void cacheLinks​(org.apache.commons.collections.keyvalue.MultiKey key,
                       java.util.Collection<PartnerLink> results)
        Parameters:
        key - mine + identifier + organism
        results - homologues for this key combo

      • getMine

        public Mine getMine​(java.lang.String mineName)
        Parameters:
        mineName - name of mine
        Returns:
        The mine properties object.