Package com.lucidworks.querying.api

Interface QueryResponse

public interface QueryResponse
Fusion query response. Part of the QueryRequestResponse and populated after the result set has been retrieved from Solr.

  • Method Details

    • getStatusCode

      Optional<Integer> getStatusCode()
      Returns:
      the status code returned from Solr

    • getHeaders

      Map<String,Collection<String>> getHeaders()
      Returns:
      the response headers

    • getTotalTime

      long getTotalTime()
      Returns:
      the total amount of time your query spent passing through the query pipeline

    • getNumFound

      long getNumFound()
      Returns:
      the number of documents in the search index that matched your query

    • getMaxScore

      double getMaxScore()
      Returns:
      the scoring of the topmost document in query’s result set.

    • getStart

      long getStart()
      Returns:
      the offset into a query’s result set.

    • getDocIds

      List<String> getDocIds()
      Returns:
      the IDs of all the documents in the query’s result set.

    • getDocuments

      List<Document> getDocuments()
      Returns:
      the documents in the query’s result set.

    • updateDocuments

      void updateDocuments(List<Document> updatedDocuments)
      Update documents in the query’s result set. This could be used to, for example, reorder, redact, or rewrite documents.
      Parameters:
      updatedDocuments - a list of updated documents

    • getFacets

      Map<String,Map<String,Object>> getFacets()
      Returns:
      the facets in the query’s result set. Returned as 'facet type' mapped to 'field name' mapped to 'facet count entries'.

    • updateFacets

      void updateFacets(Map<String,Map<String,Object>> facets)
      Update facets in the query’s result set.
      Parameters:
      facets - a map of updated facets.

    • getHighlighting

      Map<String,Map<String,Object>> getHighlighting()
      Returns:
      highlighted snippets in the query’s result set. Returned as 'Doc ID' mapped to 'Field name' mapped to 'Snippets'.

    • updateHighlighting

      void updateHighlighting(Map<String,Map<String,Object>> highlighting)
      Update highlighted snippets in the query’s result set.
      Parameters:
      highlighting - a map of updated highlighted snippets.

    • getGroupedResults

      Map<String,Map<String,Object>> getGroupedResults()
      Returns:
      grouped results in the query’s result set. Returned as 'group field name' or 'group query' mapped to grouping data.