Package org.intermine.api.searchengine

Interface KeywordSearchHandler

  • All Known Implementing Classes:
    SolrKeywordSearchHandler
    public interface KeywordSearchHandler
    Interface for handling indexes.
    Author:
    arunans23

    • Method Summary

      All Methods Instance Methods Abstract 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

    • Method Detail

      • doKeywordSearch

        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
        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

        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
        Parameters:
        im - IntermineAPI instance
        searchString - 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
        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

        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
        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