Uses of Class
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 Collectors
org.apache.solr.search.grouping.distributed.command	Internal classes used to implement distributed result grouping
org.apache.solr.search.join	Classes related to joins.

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

Methods in org.apache.solr.handler.component that return DocSet

Modifier and Type	Method	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	Description
protected void	PivotFacetProcessor.addPivotQueriesAndRanges(org.apache.solr.common.util.NamedList<Object> pivot, org.apache.solr.common.params.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 org.apache.solr.common.util.NamedList<Object>	SpatialHeatmapFacets.getHeatmapForField(String fieldKey, String fieldName, ResponseBuilder rb, org.apache.solr.common.params.SolrParams params, DocSet docSet)	Called by SimpleFacets to compute heatmap facets.
protected SimpleFacets	FacetComponent.newSimpleFacets(SolrQueryRequest req, DocSet docSet, org.apache.solr.common.params.SolrParams params, ResponseBuilder rb)
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	Description
PivotFacetProcessor(SolrQueryRequest req, DocSet docs, org.apache.solr.common.params.SolrParams params, ResponseBuilder rb)
RangeFacetProcessor(SolrQueryRequest req, DocSet docs, org.apache.solr.common.params.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	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	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	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	Description
protected DocSet	SimpleFacets.computeDocSet(DocSet baseDocSet, List<String> excludeTagList)
static org.apache.solr.common.util.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 org.apache.solr.common.util.NamedList<Integer>	DocValuesFacets.getCounts(SolrIndexSearcher searcher, DocSet docs, String fieldName, int offset, int limit, int mincount, boolean missing, String sort, String prefix, Predicate<org.apache.lucene.util.BytesRef> termFilter, FacetDebugInfo fdebug)
static StatsValues	DocValuesStats.getCounts(SolrIndexSearcher searcher, StatsField statsField, DocSet docs, String[] facet)
org.apache.solr.common.util.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)	Works like SimpleFacets.getFacetTermEnumCounts(SolrIndexSearcher, DocSet, String, int, int, int, boolean, String, String, Predicate, boolean) but takes a substring directly for the contains check rather than a Predicate instance.
org.apache.solr.common.util.NamedList<Integer>	SimpleFacets.getFacetTermEnumCounts(SolrIndexSearcher searcher, DocSet docs, String field, int offset, int limit, int mincount, boolean missing, String sort, String prefix, Predicate<org.apache.lucene.util.BytesRef> termFilter, 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.
org.apache.solr.common.util.NamedList<Integer>	SimpleFacets.getGroupedCounts(SolrIndexSearcher searcher, DocSet base, String field, boolean multiToken, int offset, int limit, int mincount, boolean missing, String sort, String prefix, Predicate<org.apache.lucene.util.BytesRef> termFilter)
int	SimpleFacets.getGroupedFacetQueryCount(org.apache.lucene.search.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	Description
IntervalFacets(SchemaField schemaField, SolrIndexSearcher searcher, DocSet docs, String[] intervals, org.apache.solr.common.params.SolrParams params)	Constructor that accepts un-parsed intervals using "interval faceting" syntax.
IntervalFacets(SchemaField schemaField, SolrIndexSearcher searcher, DocSet docs, IntervalFacets.FacetInterval[] intervals)	Constructor that accepts an already constructed array of IntervalFacets.FacetInterval objects.
ParsedParams(org.apache.solr.common.params.SolrParams localParams, org.apache.solr.common.params.SolrParams params, org.apache.solr.common.params.SolrParams required, String facetValue, DocSet docs, String key, List<String> tags, int threads)
SimpleFacets(SolrQueryRequest req, DocSet docs, org.apache.solr.common.params.SolrParams params)
SimpleFacets(SolrQueryRequest req, DocSet docs, org.apache.solr.common.params.SolrParams params, ResponseBuilder rb)

Uses of DocSet in org.apache.solr.search

Subclasses of DocSet in org.apache.solr.search

Modifier and Type	Class	Description
class	BitDocSet	A FixedBitSet based implementation of a DocSet.
class	SortedIntDocSet	A simple sorted int[] array implementation of DocSet, good for small sets.

Fields in org.apache.solr.search declared as DocSet

Modifier and Type	Field	Description
DocSet	SolrIndexSearcher.ProcessedFilter.answer
DocSet	DocListAndSet.docSet

Methods in org.apache.solr.search that return DocSet

Modifier and Type	Method	Description
DocSet	BitDocSet.andNot(DocSet other)
abstract 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(org.apache.lucene.util.FixedBitSet filter)
DocSet	DocSetBuilder.buildUniqueInOrder(org.apache.lucene.util.FixedBitSet filter)	Only use this if you know there were no duplicates and that docs were collected in-order!
abstract DocSet	DocSet.clone()
DocSet	DocSetProducer.createDocSet(SolrIndexSearcher searcher)
static DocSet	DocSetUtil.createDocSet(SolrIndexSearcher searcher, org.apache.lucene.index.Term term)
static DocSet	DocSetUtil.createDocSet(SolrIndexSearcher searcher, org.apache.lucene.search.Query query, DocSet filter)
static DocSet	DocSetUtil.createDocSetGeneric(SolrIndexSearcher searcher, org.apache.lucene.search.Query query)
static DocSet	DocSet.empty()	An empty instance (has no docs).
DocSet	DocSetCollector.getDocSet()
static DocSet	DocSetUtil.getDocSet(DocSetCollector collector, SolrIndexSearcher searcher)	This variant of getDocSet will attempt to do some deduplication on certain DocSets such as DocSets that match numDocs.
static DocSet	DocSetUtil.getDocSet(DocSet docs, SolrIndexSearcher searcher)	This variant of getDocSet maps all sets with size numDocs to searcher.getLiveDocs.
DocSet	QueryResult.getDocSet()
DocSet	SolrIndexSearcher.getDocSet(List<org.apache.lucene.search.Query> queries)	Returns the set of document ids matching all queries.
DocSet	SolrIndexSearcher.getDocSet(org.apache.lucene.search.Query query)	Returns the set of document ids matching both the query.
DocSet	SolrIndexSearcher.getDocSet(org.apache.lucene.search.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(org.apache.lucene.search.Query query, DocSet filter)
DocSet	QueryCommand.getFilter()
DocSet	BitDocSet.intersection(DocSet other)
abstract DocSet	DocSet.intersection(DocSet other)	Returns the intersection of this set with another set.
DocSet	SortedIntDocSet.intersection(DocSet other)
static DocSet	DocSetUtil.toSmallSet(BitDocSet bitSet)
DocSet	BitDocSet.union(DocSet other)
abstract DocSet	DocSet.union(DocSet other)	Returns the union of this set with another set.
DocSet	SortedIntDocSet.union(DocSet other)

Methods in org.apache.solr.search that return types with arguments of type DocSet

Modifier and Type	Method	Description
SolrCache<org.apache.lucene.search.Query,DocSet>	SolrIndexSearcher.getFilterCache()

Methods in org.apache.solr.search with parameters of type DocSet

Modifier and Type	Method	Description
protected static void	BitDocSet.andNot(org.apache.lucene.util.FixedBitSet bits, DocSet other)	Helper method for andNot that takes FixedBitSet and DocSet.
DocSet	BitDocSet.andNot(DocSet other)
abstract 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(org.apache.lucene.search.Query query, DocSet optionalAnswer, boolean mustCache)	Compute and cache the DocSet that matches a query.
static void	DocSetUtil.collectSortedDocSet(DocSet docs, org.apache.lucene.index.IndexReader reader, org.apache.lucene.search.Collector collector)
static DocSet	DocSetUtil.createDocSet(SolrIndexSearcher searcher, org.apache.lucene.search.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(org.apache.lucene.search.Query query, DocSet filter, org.apache.lucene.search.Sort lsort, int offset, int len)	Returns documents matching both query and filter and sorted by sort.
DocListAndSet	SolrIndexSearcher.getDocListAndSet(org.apache.lucene.search.Query query, DocSet filter, org.apache.lucene.search.Sort lsort, int offset, int len)	Returns documents matching both query and filter and sorted by sort.
DocListAndSet	SolrIndexSearcher.getDocListAndSet(org.apache.lucene.search.Query query, DocSet filter, org.apache.lucene.search.Sort lsort, int offset, int len, int flags)	Returns documents matching both query and filter and sorted by sort.
static DocSet	DocSetUtil.getDocSet(DocSet docs, SolrIndexSearcher searcher)	This variant of getDocSet maps all sets with size numDocs to searcher.getLiveDocs.
DocSet	SolrIndexSearcher.getDocSet(org.apache.lucene.search.Query query, DocSet filter)	Returns the set of document ids matching both the query and the filter.
protected DocSet	SolrIndexSearcher.getDocSetNC(org.apache.lucene.search.Query query, DocSet filter)
SolrIndexSearcher.ProcessedFilter	SolrIndexSearcher.getProcessedFilter(DocSet setFilter, List<org.apache.lucene.search.Query> queries)	INTERNAL: Processes conjunction (AND) of both args into a SolrIndexSearcher.ProcessedFilter result.
DocSet	BitDocSet.intersection(DocSet other)
abstract DocSet	DocSet.intersection(DocSet other)	Returns the intersection of this set with another set.
DocSet	SortedIntDocSet.intersection(DocSet other)
int	BitDocSet.intersectionSize(DocSet other)
abstract int	DocSet.intersectionSize(DocSet other)	Returns the number of documents of the intersection of this set with another set.
int	SortedIntDocSet.intersectionSize(DocSet other)
boolean	BitDocSet.intersects(DocSet other)
abstract boolean	DocSet.intersects(DocSet other)	Returns true if these sets have any elements in common
boolean	SolrIndexSearcher.intersects(DocSet a, SolrIndexSearcher.DocsEnumState deState)
boolean	SortedIntDocSet.intersects(DocSet other)
int	SolrIndexSearcher.numDocs(org.apache.lucene.search.Query a, DocSet b)	Returns the number of documents that match both a and b.
int	SolrIndexSearcher.numDocs(DocSet a, SolrIndexSearcher.DocsEnumState deState)
void	QueryResult.setDocSet(DocSet set)
QueryCommand	QueryCommand.setFilter(DocSet filter)
DocSet	BitDocSet.union(DocSet other)
abstract DocSet	DocSet.union(DocSet other)	Returns the union of this set with another set.
DocSet	SortedIntDocSet.union(DocSet other)
int	BitDocSet.unionSize(DocSet other)
int	DocSet.unionSize(DocSet other)	Returns the number of documents of the union of this set with another set.

Method parameters in org.apache.solr.search with type arguments of type DocSet

Modifier and Type	Method	Description
BitDocSet	SolrIndexSearcher.offerLiveDocs(Supplier<DocSet> docSetSupplier, int suppliedSize)	If some process external to SolrIndexSearcher has produced a DocSet whose cardinality matches that of `liveDocs`, this method provides such caller the ability to offer its own DocSet to be cached in the searcher.

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

Methods in org.apache.solr.search.facet that return DocSet

Modifier and Type	Method	Description
DocSet	FacetContext.getBase()
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	Description
int	SlotAcc.collect(DocSet docs, int slot, IntFunction<SlotAcc.SlotContext> slotContext)	Bulk collection of all documents in a slot.
Object	FacetRequest.process(SolrQueryRequest req, DocSet domain)	Process this facet request against the given domain of docs.
protected void	FacetProcessor.processStats(org.apache.solr.common.util.SimpleOrderedMap<Object> bucket, org.apache.lucene.search.Query bucketQ, DocSet docs, long docCount)
FacetContext	FacetContext.sub(org.apache.lucene.search.Query filter, DocSet domain)
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	Description
FilterCollector(DocSet filter, org.apache.lucene.search.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	Description
QueryCommand.Builder	QueryCommand.Builder.setDocSet(DocSet docSet)

Uses of DocSet in org.apache.solr.search.join

Constructors in org.apache.solr.search.join with parameters of type DocSet

Constructor	Description
GraphPointsCollector(SchemaField collectField, DocSet skipSet, DocSet leafNodes)