Class LocalMine

  • All Implemented Interfaces:
    ConfigurableMine, Mine

    public class LocalMine
    extends java.lang.Object
    implements ConfigurableMine
    A mine that refers to the local application instance.
    Author:
    Alex Kalderimis
    • Constructor Summary

      Constructors 
      Constructor Description
      LocalMine​(InterMineAPI api, java.util.Properties props)
      Construct a mine that refers to the local application instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void configure​(java.util.Properties props)
      Configure this mine with a the properties provided.
      java.lang.String getBgcolor()  
      java.lang.String getDefaultValue()
      get first default value.
      java.util.Set<java.lang.String> getDefaultValues()  
      java.lang.String getDescription()  
      java.lang.String getFrontcolor()  
      java.lang.String getID()  
      java.lang.String getLogo()  
      Model getModel()
      Get the main model associated with this application.
      java.lang.String getName()  
      java.lang.String getReleaseVersion()  
      java.util.List<java.util.List<java.lang.Object>> getRows​(java.lang.String xml)
      Run a path query and get back all the results.
      java.util.List<java.util.List<java.lang.Object>> getRows​(PathQuery query)
      Run a path query and get back all the results.
      java.lang.String getUrl()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LocalMine

        public LocalMine​(InterMineAPI api,
                         java.util.Properties props)
        Construct a mine that refers to the local application instance.
        Parameters:
        api - The InterMine API of this application
        props - The web-properties.
    • Method Detail

      • configure

        public void configure​(java.util.Properties props)
        Description copied from interface: ConfigurableMine
        Configure this mine with a the properties provided.
        Specified by:
        configure in interface ConfigurableMine
        Parameters:
        props - The properties to consume.
      • getID

        public java.lang.String getID()
        Returns:
        The identifier of this mine.
      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface Mine
        Returns:
        the name of the mine
      • getDescription

        public java.lang.String getDescription()
        Specified by:
        getDescription in interface Mine
        Returns:
        the description of the mine
      • getUrl

        public java.lang.String getUrl()
        Specified by:
        getUrl in interface Mine
        Returns:
        the url to the mine
      • getLogo

        public java.lang.String getLogo()
        Specified by:
        getLogo in interface Mine
        Returns:
        the logo
      • getBgcolor

        public java.lang.String getBgcolor()
        Specified by:
        getBgcolor in interface Mine
        Returns:
        bgcolor
      • getFrontcolor

        public java.lang.String getFrontcolor()
        Specified by:
        getFrontcolor in interface Mine
        Returns:
        frontcolor
      • getReleaseVersion

        public java.lang.String getReleaseVersion()
        Specified by:
        getReleaseVersion in interface Mine
        Returns:
        the releaseVersion
      • getModel

        public Model getModel()
        Description copied from interface: Mine
        Get the main model associated with this application.
        Specified by:
        getModel in interface Mine
        Returns:
        The data model.
      • getDefaultValues

        public java.util.Set<java.lang.String> getDefaultValues()
        Specified by:
        getDefaultValues in interface Mine
        Returns:
        the defaultValue
      • getDefaultValue

        public java.lang.String getDefaultValue()
        Description copied from interface: Mine
        get first default value. used in querybuilder to select default extra value
        Specified by:
        getDefaultValue in interface Mine
        Returns:
        the defaultValue
      • getRows

        public java.util.List<java.util.List<java.lang.Object>> getRows​(PathQuery query)
        Description copied from interface: Mine
        Run a path query and get back all the results.
        Specified by:
        getRows in interface Mine
        Parameters:
        query - The query to run.
        Returns:
        A list of rows.
      • getRows

        public java.util.List<java.util.List<java.lang.Object>> getRows​(java.lang.String xml)
        Description copied from interface: Mine
        Run a path query and get back all the results.
        Specified by:
        getRows in interface Mine
        Parameters:
        xml - The query to run, in XML format.
        Returns:
        A list of rows.