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

- Packages that use DocSet
  Package | Description
  --- | ---
  org.apache.solr.handler.component | `SearchComponent` implementations for use in `SearchHandler`
  org.apache.solr.query | Solr Queries
  org.apache.solr.request | APIs and classes for dealing with Solr requests
  org.apache.solr.search | APIs and classes for parsing and processing search requests
  org.apache.solr.search.facet | APIs and classes for the JSON Facet API.
  org.apache.solr.search.grouping.collector | Grouping related `Collector`s
  org.apache.solr.search.grouping.distributed.command | Internal classes used to implement distributed result grouping

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

    Methods in org.apache.solr.handler.component that return DocSet
    Modifier and Type | Method and Description
    --- | ---
    `DocSet` | StatsField.`computeBaseDocSet()` Computes a base `DocSet` for the current request to be used when computing global stats for the local index.

    Methods in org.apache.solr.handler.component with parameters of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | PivotFacetProcessor.`addPivotQueriesAndRanges(NamedList<Object> pivot, SolrParams params, DocSet docs, List<FacetComponent.FacetBase> facetQueries, List<RangeFacetRequest> facetRanges)` Add facet.queries and facet.ranges to the pivot response if needed
    `StatsValues` | StatsField.`computeLocalStatsValues(DocSet base)` Computes the `StatsValues` for this `StatsField` relative to the specified `DocSet`
    `static NamedList<Object>` | SpatialHeatmapFacets.`getHeatmapForField(String fieldKey, String fieldName, ResponseBuilder rb, SolrParams params, DocSet docSet)` Called by `SimpleFacets` to compute heatmap facets.
    `protected int` | RangeFacetProcessor.`rangeCount(DocSet subset, RangeFacetRequest rfr, RangeFacetRequest.FacetRange fr)` Macro for getting the numDocs of range over docs

    Constructors in org.apache.solr.handler.component with parameters of type DocSet
    Constructor and Description
    `PivotFacetProcessor(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`
    `RangeFacetProcessor(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`

  - ### Uses of DocSet in org.apache.solr.query

    Methods in org.apache.solr.query that return DocSet
    Modifier and Type | Method and Description
    --- | ---
    `DocSet` | SolrRangeQuery.`createDocSet(SolrIndexSearcher searcher)`

  - ### Uses of DocSet in org.apache.solr.request

    Fields in org.apache.solr.request declared as DocSet
    Modifier and Type | Field and Description
    --- | ---
    `DocSet` | SimpleFacets.ParsedParams.`docs`
    `protected DocSet` | SimpleFacets.`docsOrig` The main set of documents all facet counts should be relative to

    Methods in org.apache.solr.request that return DocSet
    Modifier and Type | Method and Description
    --- | ---
    `protected DocSet` | SimpleFacets.`computeDocSet(DocSet baseDocSet, List<String> excludeTagList)`
    `DocSet` | SimpleFacets.`getDocsOrig()`

    Methods in org.apache.solr.request with parameters of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `protected DocSet` | SimpleFacets.`computeDocSet(DocSet baseDocSet, List<String> excludeTagList)`
    `static NamedList<Integer>` | DocValuesFacets.`getCounts(SolrIndexSearcher searcher, DocSet docs, String fieldName, int offset, int limit, int mincount, boolean missing, String sort, String prefix, String contains, boolean ignoreCase, FacetDebugInfo fdebug)`
    `static StatsValues` | DocValuesStats.`getCounts(SolrIndexSearcher searcher, StatsField statsField, DocSet docs, String[] facet)`
    `NamedList<Integer>` | SimpleFacets.`getFacetTermEnumCounts(SolrIndexSearcher searcher, DocSet docs, String field, int offset, int limit, int mincount, boolean missing, String sort, String prefix, String contains, boolean ignoreCase, boolean intersectsCheck)` Returns a list of terms in the specified field along with the corresponding count of documents in the set that match that constraint.
    `static int` | SimpleFacets.`getFieldMissingCount(SolrIndexSearcher searcher, DocSet docs, String fieldName)` Returns a count of the documents in the set which do not have any terms for for the specified field.
    `NamedList<Integer>` | SimpleFacets.`getGroupedCounts(SolrIndexSearcher searcher, DocSet base, String field, boolean multiToken, int offset, int limit, int mincount, boolean missing, String sort, String prefix, String contains, boolean ignoreCase)`
    `int` | SimpleFacets.`getGroupedFacetQueryCount(Query facetQuery, DocSet docSet)` Returns a grouped facet count for the facet query
    `SimpleFacets.ParsedParams` | SimpleFacets.ParsedParams.`withDocs(DocSet docs)`

    Constructors in org.apache.solr.request with parameters of type DocSet
    Constructor and Description
    `IntervalFacets(SchemaField schemaField, SolrIndexSearcher searcher, DocSet docs, IntervalFacets.FacetInterval[] intervals)` Constructor that accepts an already constructed array of `IntervalFacets.FacetInterval` objects.
    `IntervalFacets(SchemaField schemaField, SolrIndexSearcher searcher, DocSet docs, String[] intervals, SolrParams params)` Constructor that accepts un-parsed intervals using "interval faceting" syntax.
    `ParsedParams(SolrParams localParams, SolrParams params, SolrParams required, String facetValue, DocSet docs, String key, List<String> tags, int threads)`
    `SimpleFacets(SolrQueryRequest req, DocSet docs, SolrParams params)`
    `SimpleFacets(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`

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

    Subinterfaces of DocSet in org.apache.solr.search
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DocList` `DocList` represents the result of a query: an ordered list of document ids with optional score.

    Classes in org.apache.solr.search that implement DocSet
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BitDocSet` `BitDocSet` represents an unordered set of Lucene Document Ids using a BitSet.
    `class` | `DocSlice` `DocSlice` implements DocList as an array of docids and optional scores.
    `class` | `HashDocSet` `HashDocSet` represents an unordered set of Lucene Document Ids using a primitive int hash table.
    `class` | `SortedIntDocSet` `SortedIntDocSet` represents a sorted set of Lucene Document Ids.

    Fields in org.apache.solr.search declared as DocSet
    Modifier and Type | Field and Description
    --- | ---
    `DocSet` | SolrIndexSearcher.ProcessedFilter.`answer`
    `DocSet` | DocListAndSet.`docSet`
    `static DocSet` | DocSet.`EMPTY`

    Methods in org.apache.solr.search that return DocSet
    Modifier and Type | Method and Description
    --- | ---
    `DocSet` | HashDocSet.`andNot(DocSet other)`
    `DocSet` | BitDocSet.`andNot(DocSet other)`
    `DocSet` | DocSet.`andNot(DocSet other)` Returns the documents in this set that are not in the other set.
    `DocSet` | SortedIntDocSet.`andNot(DocSet other)`
    `DocSet` | DocSetBuilder.`build(FixedBitSet filter)`
    `DocSet` | DocSetBuilder.`buildUniqueInOrder(FixedBitSet filter)` Only use this if you know there were no duplicates and that docs were collected in-order!
    `DocSet` | DocSetProducer.`createDocSet(SolrIndexSearcher searcher)`
    `static DocSet` | DocSetUtil.`createDocSet(SolrIndexSearcher searcher, Query query, DocSet filter)`
    `static DocSet` | DocSetUtil.`createDocSet(SolrIndexSearcher searcher, Term term)`
    `static DocSet` | DocSetUtil.`createDocSetGeneric(SolrIndexSearcher searcher, Query query)`
    `DocSet` | QueryResult.`getDocSet()`
    `DocSet` | DocSetCollector.`getDocSet()`
    `DocSet` | SolrIndexSearcher.`getDocSet(List<Query> queries)` Returns the set of document ids matching all queries.
    `DocSet` | SolrIndexSearcher.`getDocSet(Query query)` Returns the set of document ids matching a query.
    `DocSet` | SolrIndexSearcher.`getDocSet(Query query, DocSet filter)` Returns the set of document ids matching both the query and the filter.
    `DocSet` | SolrIndexSearcher.`getDocSet(SolrIndexSearcher.DocsEnumState deState)`
    `protected DocSet` | SolrIndexSearcher.`getDocSetNC(Query query, DocSet filter)`
    `DocSet` | QueryCommand.`getFilter()`
    `DocSet` | HashDocSet.`intersection(DocSet other)`
    `DocSet` | DocSet.`intersection(DocSet other)` Returns the intersection of this set with another set.
    `DocSet` | DocSlice.`intersection(DocSet other)`
    `DocSet` | SortedIntDocSet.`intersection(DocSet other)`
    `static DocSet` | DocSetUtil.`toSmallSet(BitDocSet bitSet)`
    `DocSet` | HashDocSet.`union(DocSet other)`
    `DocSet` | BitDocSet.`union(DocSet other)`
    `DocSet` | DocSet.`union(DocSet other)` Returns the union of this set with another set.

    Methods in org.apache.solr.search that return types with arguments of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `SolrCache<Query,DocSet>` | SolrIndexSearcher.`getFilterCache()`

    Methods in org.apache.solr.search with parameters of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `void` | BitDocSet.`addAllTo(DocSet target)`
    `void` | DocSet.`addAllTo(DocSet target)` Adds all the docs from this set to the target set.
    `void` | SortedIntDocSet.`addAllTo(DocSet target)`
    `DocSet` | HashDocSet.`andNot(DocSet other)`
    `DocSet` | BitDocSet.`andNot(DocSet other)`
    `DocSet` | DocSet.`andNot(DocSet other)` Returns the documents in this set that are not in the other set.
    `DocSet` | SortedIntDocSet.`andNot(DocSet other)`
    `int` | BitDocSet.`andNotSize(DocSet other)`
    `int` | DocSet.`andNotSize(DocSet other)` Returns the number of documents in this set that are not in the other set.
    `void` | SolrIndexSearcher.`cacheDocSet(Query query, DocSet optionalAnswer, boolean mustCache)` Compute and cache the DocSet that matches a query.
    `static void` | DocSetUtil.`collectSortedDocSet(DocSet docs, IndexReader reader, Collector collector)`
    `static DocSet` | DocSetUtil.`createDocSet(SolrIndexSearcher searcher, Query query, DocSet filter)`
    `static boolean` | DocSetUtil.`equals(DocSet a, DocSet b)` Iterates DocSets to test for equality - slow and for testing purposes only.
    `DocList` | SolrIndexSearcher.`getDocList(Query query, DocSet filter, Sort lsort, int offset, int len)` Returns documents matching both `query` and `filter` and sorted by `sort`.
    `DocListAndSet` | SolrIndexSearcher.`getDocListAndSet(Query query, DocSet filter, Sort lsort, int offset, int len)` Returns documents matching both `query` and `filter` and sorted by `sort`.
    `DocListAndSet` | SolrIndexSearcher.`getDocListAndSet(Query query, DocSet filter, Sort lsort, int offset, int len, int flags)` Returns documents matching both `query` and `filter` and sorted by `sort`.
    `DocSet` | SolrIndexSearcher.`getDocSet(Query query, DocSet filter)` Returns the set of document ids matching both the query and the filter.
    `protected DocSet` | SolrIndexSearcher.`getDocSetNC(Query query, DocSet filter)`
    `SolrIndexSearcher.ProcessedFilter` | SolrIndexSearcher.`getProcessedFilter(DocSet setFilter, List<Query> queries)`
    `DocSet` | HashDocSet.`intersection(DocSet other)`
    `DocSet` | DocSet.`intersection(DocSet other)` Returns the intersection of this set with another set.
    `DocSet` | DocSlice.`intersection(DocSet other)`
    `DocSet` | SortedIntDocSet.`intersection(DocSet other)`
    `int` | HashDocSet.`intersectionSize(DocSet other)`
    `int` | BitDocSet.`intersectionSize(DocSet other)`
    `int` | DocSet.`intersectionSize(DocSet other)` Returns the number of documents of the intersection of this set with another set.
    `int` | DocSlice.`intersectionSize(DocSet other)`
    `int` | SortedIntDocSet.`intersectionSize(DocSet other)`
    `boolean` | HashDocSet.`intersects(DocSet other)`
    `boolean` | BitDocSet.`intersects(DocSet other)`
    `boolean` | DocSet.`intersects(DocSet other)` Returns true if these sets have any elements in common
    `boolean` | DocSlice.`intersects(DocSet other)`
    `boolean` | SortedIntDocSet.`intersects(DocSet other)`
    `boolean` | SolrIndexSearcher.`intersects(DocSet a, SolrIndexSearcher.DocsEnumState deState)`
    `int` | SolrIndexSearcher.`numDocs(DocSet a, SolrIndexSearcher.DocsEnumState deState)`
    `int` | SolrIndexSearcher.`numDocs(Query a, DocSet b)` Returns the number of documents that match both `a` and `b`.
    `void` | QueryResult.`setDocSet(DocSet set)`
    `QueryCommand` | QueryCommand.`setFilter(DocSet filter)`
    `DocSet` | HashDocSet.`union(DocSet other)`
    `DocSet` | BitDocSet.`union(DocSet other)`
    `DocSet` | DocSet.`union(DocSet other)` Returns the union of this set with another set.
    `int` | BitDocSet.`unionSize(DocSet other)`
    `int` | DocSet.`unionSize(DocSet other)` Returns the number of documents of the union of this set with another set.

  - ### Uses of DocSet in org.apache.solr.search.facet

    Methods in org.apache.solr.search.facet that return DocSet
    Modifier and Type | Method and Description
    --- | ---
    `static DocSet` | BlockJoin.`toChildren(DocSet parentInput, BitDocSet parentList, DocSet acceptDocs, QueryContext qcontext)` acceptDocs will normally be used to avoid deleted documents from being generated as part of the answer DocSet (just use *:*) although it can be used to further constrain the generated documents.
    `static DocSet` | BlockJoin.`toParents(DocSet childInput, BitDocSet parentList, QueryContext qcontext)` childInput may also contain parents (i.e.

    Methods in org.apache.solr.search.facet with parameters of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `int` | SlotAcc.`collect(DocSet docs, int slot)`
    `static FacetProcessor<?>` | FacetProcessor.`createProcessor(SolrQueryRequest req, Map<String,Object> params, DocSet docs)` factory method for invoking json facet framework as whole
    `protected void` | FacetProcessor.`processStats(SimpleOrderedMap<Object> bucket, DocSet docs, int docCount)`
    `static DocSet` | BlockJoin.`toChildren(DocSet parentInput, BitDocSet parentList, DocSet acceptDocs, QueryContext qcontext)` acceptDocs will normally be used to avoid deleted documents from being generated as part of the answer DocSet (just use *:*) although it can be used to further constrain the generated documents.
    `static DocSet` | BlockJoin.`toParents(DocSet childInput, BitDocSet parentList, QueryContext qcontext)` childInput may also contain parents (i.e.

  - ### Uses of DocSet in org.apache.solr.search.grouping.collector

    Constructors in org.apache.solr.search.grouping.collector with parameters of type DocSet
    Constructor and Description
    `FilterCollector(DocSet filter, Collector delegate)`

  - ### Uses of DocSet in org.apache.solr.search.grouping.distributed.command

    Methods in org.apache.solr.search.grouping.distributed.command with parameters of type DocSet
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand.Builder` | QueryCommand.Builder.`setDocSet(DocSet docSet)`

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