## Uses of Interface
org.apache.solr.search.DocList

- Packages that use DocList
  Package | Description
  --- | ---
  org.apache.solr.handler | Concrete implementations of `SolrRequestHandler`
  org.apache.solr.handler.component | `SearchComponent` implementations for use in `SearchHandler`
  org.apache.solr.highlight | `SolrHighlighter` API and related implementations and utilities
  org.apache.solr.response | API and implementations of `QueryResponseWriter` for formatting Solr request responses
  org.apache.solr.search | APIs and classes for parsing and processing search requests
  org.apache.solr.util | Common utility classes used throughout Solr

- - ### Uses of DocList in org.apache.solr.handler

    Methods in org.apache.solr.handler with parameters of type DocList
    Modifier and Type | Method and Description
    --- | ---
    `NamedList<BooleanQuery>` | MoreLikeThisHandler.MoreLikeThisHelper.`getMoreLikeTheseQuery(DocList docs)`

  - ### Uses of DocList in org.apache.solr.handler.component

    Methods in org.apache.solr.handler.component with parameters of type DocList
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | ResponseLogComponent.`processIds(ResponseBuilder rb, DocList dl, IndexSchema schema, SolrIndexSearcher searcher)`
    `protected void` | ResponseLogComponent.`processScores(ResponseBuilder rb, DocList dl, IndexSchema schema, SolrIndexSearcher searcher)`

  - ### Uses of DocList in org.apache.solr.highlight

    Methods in org.apache.solr.highlight with parameters of type DocList
    Modifier and Type | Method and Description
    --- | ---
    `NamedList<Object>` | PostingsSolrHighlighter.`doHighlighting(DocList docs, Query query, SolrQueryRequest req, String[] defaultFields)`
    `abstract NamedList<Object>` | SolrHighlighter.`doHighlighting(DocList docs, Query query, SolrQueryRequest req, String[] defaultFields)` Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
    `NamedList<Object>` | DefaultSolrHighlighter.`doHighlighting(DocList docs, Query query, SolrQueryRequest req, String[] defaultFields)` Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
    `protected int[]` | PostingsSolrHighlighter.`toDocIDs(DocList docs)` Converts solr's DocList to the int[] docIDs

  - ### Uses of DocList in org.apache.solr.response

    Methods in org.apache.solr.response that return DocList
    Modifier and Type | Method and Description
    --- | ---
    `abstract DocList` | ResultContext.`getDocList()`
    `DocList` | BasicResultContext.`getDocList()`

    Constructors in org.apache.solr.response with parameters of type DocList
    Constructor and Description
    `BasicResultContext(DocList docList, ReturnFields returnFields, SolrIndexSearcher searcher, Query query, SolrQueryRequest req)`
    `BasicResultContext(ResponseBuilder rb, DocList docList)`

  - ### Uses of DocList in org.apache.solr.search

    Classes in org.apache.solr.search that implement DocList
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DocSlice` `DocSlice` implements DocList as an array of docids and optional scores.

    Fields in org.apache.solr.search declared as DocList
    Modifier and Type | Field and Description
    --- | ---
    `DocList` | DocListAndSet.`docList`
    `DocList` | Grouping.`mainResult`

    Methods in org.apache.solr.search that return DocList
    Modifier and Type | Method and Description
    --- | ---
    `protected DocList` | Grouping.Command.`createSimpleResponse()`
    `DocList` | QueryResult.`getDocList()`
    `protected DocList` | Grouping.Command.`getDocList(GroupDocs groups)`
    `DocList` | SolrIndexSearcher.`getDocList(Query query, DocSet filter, Sort lsort, int offset, int len)` Returns documents matching both `query` and `filter` and sorted by `sort`.
    `DocList` | SolrIndexSearcher.`getDocList(Query query, List<Query> filterList, Sort lsort, int offset, int len, int flags)` Returns documents matching both `query` and the intersection of the `filterList`, sorted by `sort`.
    `DocList` | SolrIndexSearcher.`getDocList(Query query, Query filter, Sort lsort, int offset, int len)` Returns documents matching both `query` and `filter` and sorted by `sort`.
    `DocList` | DocSlice.`subset(int offset, int len)`
    `DocList` | DocList.`subset(int offset, int len)` Get a subset of an existing DocList.

    Methods in org.apache.solr.search with parameters of type DocList
    Modifier and Type | Method and Description
    --- | ---
    `Document[]` | SolrIndexSearcher.`readDocs(DocList ids)` Takes a list of document IDs, and returns an array of Documents containing all of the stored fields.
    `void` | SolrIndexSearcher.`readDocs(Document[] docs, DocList ids)` Takes a list of docs (the doc ids actually), and reads them into an array of Documents.
    `void` | SolrIndexSearcher.`readDocs(Document[] docs, DocList ids, Set<String> fields)` Takes a list of docs (the doc ids actually) and a set of fields to load, and reads them into an array of Documents.
    `void` | QueryResult.`setDocList(DocList list)`

  - ### Uses of DocList in org.apache.solr.util

    Methods in org.apache.solr.util that return DocList
    Modifier and Type | Method and Description
    --- | ---
    `static DocList` | SolrPluginUtils.`doSimpleQuery(String sreq, SolrQueryRequest req, int start, int limit)` Executes a basic query

    Methods in org.apache.solr.util with parameters of type DocList
    Modifier and Type | Method and Description
    --- | ---
    `static SolrDocumentList` | SolrPluginUtils.`docListToSolrDocumentList(DocList docs, SolrIndexSearcher searcher, Set<String> fields, Map<SolrDocument,Integer> ids)` Convert a DocList to a SolrDocumentList The optional param "ids" is populated with the lucene document id for each SolrDocument.
    `static NamedList` | SolrPluginUtils.`doStandardDebug(SolrQueryRequest req, String userQuery, Query query, DocList results, boolean dbgQuery, boolean dbgResults)` Returns a NamedList containing many "standard" pieces of debugging information.
    `static void` | SolrPluginUtils.`doStandardResultsDebug(SolrQueryRequest req, Query query, DocList results, boolean dbgResults, NamedList dbg)`
    `static NamedList<Explanation>` | SolrPluginUtils.`getExplanations(Query query, DocList docs, SolrIndexSearcher searcher, IndexSchema schema)` Generates an NamedList of Explanations for each item in a list of docs.
    `static void` | SolrPluginUtils.`optimizePreFetchDocs(ResponseBuilder rb, DocList docs, Query query, SolrQueryRequest req, SolrQueryResponse res)` Pre-fetch documents into the index searcher's document cache.

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.