Package org.intermine.api.searchengine.solr

Class SolrKeywordSearchHandler

  • All Implemented Interfaces:
    KeywordSearchHandler
    public final class SolrKeywordSearchHandler
extends java.lang.Object
implements KeywordSearchHandler
    Solr implementation of KeywordSearchHandler
    Author:
    nils, arunans23

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Collection<KeywordSearchFacet> doFacetSearch​(InterMineAPI im, java.lang.String queryString, java.util.Map<java.lang.String,​java.lang.String> facetValues)
      A method specifically designed to handle facet return webservice
      KeywordSearchResults doKeywordSearch​(InterMineAPI im, java.lang.String queryString, java.util.Map<java.lang.String,​java.lang.String> facetValues, java.util.List<java.lang.Integer> ids, int offSet)
      Main method to do the search
      java.util.Set<java.lang.Integer> getObjectIdsFromSearch​(InterMineAPI im, java.lang.String searchString, int offSet, java.util.Map<java.lang.String,​java.lang.String> facetValues, java.util.List<java.lang.Integer> ids, int listSize)
      A method specifically designed to be used in SaveFromIdsToBagAction class

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SolrKeywordSearchHandler

        public SolrKeywordSearchHandler()

    • Method Detail

      • doKeywordSearch

        public KeywordSearchResults doKeywordSearch​(InterMineAPI im,
                                            java.lang.String queryString,
                                            java.util.Map<java.lang.String,​java.lang.String> facetValues,
                                            java.util.List<java.lang.Integer> ids,
                                            int offSet)
        Description copied from interface: KeywordSearchHandler
        Main method to do the search
        Specified by:
        doKeywordSearch in interface KeywordSearchHandler
        Parameters:
        im - IntermineAPI instance
        queryString - the search term to be searched
        facetValues - the facet value Map that needs to be returned in the result
        ids - ids to research the search
        offSet - offSet of results
        Returns:
        results containing both facet and result rows in the KeywordSearchResuls container

      • getObjectIdsFromSearch

        public java.util.Set<java.lang.Integer> getObjectIdsFromSearch​(InterMineAPI im,
                                                               java.lang.String searchString,
                                                               int offSet,
                                                               java.util.Map<java.lang.String,​java.lang.String> facetValues,
                                                               java.util.List<java.lang.Integer> ids,
                                                               int listSize)
        Description copied from interface: KeywordSearchHandler
        A method specifically designed to be used in SaveFromIdsToBagAction class
        Specified by:
        getObjectIdsFromSearch in interface KeywordSearchHandler
        Parameters:
        im - IntermineAPI instance
        searchString - the search term to be searched
        offSet - offSet of results
        facetValues - the facet value Map that needs to be returned in the result
        ids - ids to research the search
        listSize - the listSize that needs to be returned. (ie rowSize in solr)
        Returns:
        results containing both facet and result rows in the KeywordSearchResuls container

      • doFacetSearch

        public java.util.Collection<KeywordSearchFacet> doFacetSearch​(InterMineAPI im,
                                                              java.lang.String queryString,
                                                              java.util.Map<java.lang.String,​java.lang.String> facetValues)
        Description copied from interface: KeywordSearchHandler
        A method specifically designed to handle facet return webservice
        Specified by:
        doFacetSearch in interface KeywordSearchHandler
        Parameters:
        im - IntermineAPI instance
        queryString - the search term to be searched
        facetValues - the facet value Map that needs to be returned in the result
        Returns:
        A Collection of keywordsearch facets