Package | Description |
---|---|
org.apache.lucene.search |
Code to search indices.
|
org.apache.lucene.search.grouping |
Grouping.
|
org.apache.lucene.search.grouping.function |
Support for grouping by
ValueSource . |
org.apache.lucene.search.grouping.term |
Support for grouping by indexed terms via
DocValues . |
org.apache.lucene.search.join |
Support for index-time and query-time joins.
|
Modifier and Type | Interface and Description |
---|---|
interface |
CollectorManager<C extends Collector,T>
A manager of collectors.
|
Modifier and Type | Class and Description |
---|---|
class |
CachingCollector
Caches all docs, and optionally also scores, coming from
a search, and is then able to replay them to another
collector.
|
private static class |
CachingCollector.NoScoreCachingCollector |
private static class |
CachingCollector.ScoreCachingCollector |
class |
DiversifiedTopDocsCollector
A
TopDocsCollector that controls diversity in results by ensuring no
more than maxHitsPerKey results from a common source are collected in the
final results. |
class |
EarlyTerminatingSortingCollector
|
class |
FilterCollector
Collector delegator. |
class |
MultiCollector
|
class |
PositiveScoresOnlyCollector
|
class |
SimpleCollector
Base
Collector implementation that is used to collect all contexts. |
class |
TimeLimitingCollector
The
TimeLimitingCollector is used to timeout search requests that
take longer than the maximum allowed search time limit. |
class |
TopDocsCollector<T extends ScoreDoc>
A base class for all collectors that return a
TopDocs output. |
class |
TopFieldCollector
|
private static class |
TopFieldCollector.PagingFieldCollector |
private static class |
TopFieldCollector.SimpleFieldCollector |
class |
TopScoreDocCollector
|
private static class |
TopScoreDocCollector.PagingTopScoreDocCollector |
private static class |
TopScoreDocCollector.SimpleTopScoreDocCollector |
class |
TotalHitCountCollector
Just counts the total number of hits.
|
Modifier and Type | Field and Description |
---|---|
private Collector |
TimeLimitingCollector.collector |
private Collector[] |
MultiCollector.collectors |
protected Collector |
FilterCollector.in |
Modifier and Type | Method and Description |
---|---|
<C extends Collector,T> |
IndexSearcher.search(Query query,
CollectorManager<C,T> collectorManager)
Lower-level search API.
|
Modifier and Type | Method and Description |
---|---|
static Collector |
MultiCollector.wrap(Collector... collectors)
|
static Collector |
MultiCollector.wrap(java.lang.Iterable<? extends Collector> collectors)
Wraps a list of
Collector s with a MultiCollector . |
Modifier and Type | Method and Description |
---|---|
static CachingCollector |
CachingCollector.create(Collector other,
boolean cacheScores,
double maxRAMMB)
Create a new
CachingCollector that wraps the given collector and
caches documents and scores up to the specified RAM threshold. |
static CachingCollector |
CachingCollector.create(Collector other,
boolean cacheScores,
int maxDocsToCache)
Create a new
CachingCollector that wraps the given collector and
caches documents and scores up to the specified max docs threshold. |
abstract void |
CachingCollector.replay(Collector other)
Replays the cached doc IDs (and scores) to the given Collector.
|
void |
CachingCollector.NoScoreCachingCollector.replay(Collector other) |
protected void |
IndexSearcher.search(java.util.List<LeafReaderContext> leaves,
Weight weight,
Collector collector)
Lower-level search API.
|
void |
IndexSearcher.search(Query query,
Collector results)
Lower-level search API.
|
void |
TimeLimitingCollector.setCollector(Collector collector)
This is so the same timer can be used with a multi-phase search process such as grouping.
|
static Collector |
MultiCollector.wrap(Collector... collectors)
|
Modifier and Type | Method and Description |
---|---|
static Collector |
MultiCollector.wrap(java.lang.Iterable<? extends Collector> collectors)
Wraps a list of
Collector s with a MultiCollector . |
Constructor and Description |
---|
CachingCollector(Collector in) |
EarlyTerminatingSortingCollector(Collector in,
Sort sort,
int numDocsToCollect,
Sort mergePolicySort)
Create a new
EarlyTerminatingSortingCollector instance. |
FilterCollector(Collector in)
Sole constructor.
|
MultiCollector(Collector... collectors) |
NoScoreCachingCollector(Collector in,
int maxDocsToCache) |
PositiveScoresOnlyCollector(Collector in) |
ScoreCachingCollector(Collector in,
int maxDocsToCache) |
TimeLimitingCollector(Collector collector,
Counter clock,
long ticksAllowed)
Create a TimeLimitedCollector wrapper over another
Collector with a specified timeout. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead>
This collector specializes in collecting the most relevant document (group head) for each group that match the query.
|
class |
AbstractAllGroupsCollector<GROUP_VALUE_TYPE>
A collector that collects all groups that match the
query.
|
class |
AbstractDistinctValuesCollector<GC extends AbstractDistinctValuesCollector.GroupCount<?>>
A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
|
class |
AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE>
FirstPassGroupingCollector is the first of two passes necessary
to collect grouped hits.
|
class |
AbstractGroupFacetCollector
Base class for computing grouped facets.
|
class |
AbstractSecondPassGroupingCollector<GROUP_VALUE_TYPE>
SecondPassGroupingCollector is the second of two passes
necessary to collect grouped docs.
|
class |
BlockGroupingCollector
BlockGroupingCollector performs grouping with a
single pass collector, as long as you are grouping by a
doc block field, ie all documents sharing a given group
value were indexed as a doc block using the atomic
IndexWriter.addDocuments()
or IndexWriter.updateDocuments()
API. |
Modifier and Type | Class and Description |
---|---|
class |
FunctionAllGroupHeadsCollector
An implementation of
AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping
by ValueSource . |
class |
FunctionAllGroupsCollector
A collector that collects all groups that match the
query.
|
class |
FunctionDistinctValuesCollector
Function based implementation of
AbstractDistinctValuesCollector . |
class |
FunctionFirstPassGroupingCollector
Concrete implementation of
AbstractFirstPassGroupingCollector that groups based on
ValueSource instances. |
class |
FunctionSecondPassGroupingCollector
Concrete implementation of
AbstractSecondPassGroupingCollector that groups based on
ValueSource instances. |
Modifier and Type | Class and Description |
---|---|
class |
TermAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead<?>>
A base implementation of
AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping
on a string based group field. |
(package private) static class |
TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector |
(package private) static class |
TermAllGroupHeadsCollector.OrdAllGroupHeadsCollector |
(package private) static class |
TermAllGroupHeadsCollector.OrdScoreAllGroupHeadsCollector |
(package private) static class |
TermAllGroupHeadsCollector.ScoreAllGroupHeadsCollector |
class |
TermAllGroupsCollector
A collector that collects all groups that match the
query.
|
class |
TermDistinctValuesCollector
A term based implementation of
AbstractDistinctValuesCollector that relies
on SortedDocValues to count the distinct values per group. |
class |
TermFirstPassGroupingCollector
Concrete implementation of
AbstractFirstPassGroupingCollector that groups based on
field values and more specifically uses SortedDocValues
to collect groups. |
class |
TermGroupFacetCollector
An implementation of
AbstractGroupFacetCollector that computes grouped facets based on the indexed terms
from DocValues. |
(package private) static class |
TermGroupFacetCollector.MV |
(package private) static class |
TermGroupFacetCollector.SV |
class |
TermSecondPassGroupingCollector
Concrete implementation of
AbstractSecondPassGroupingCollector that groups based on
field values and more specifically uses SortedDocValues
to collect grouped docs. |
Modifier and Type | Interface and Description |
---|---|
(package private) interface |
GenericTermsCollector |
Modifier and Type | Class and Description |
---|---|
(package private) class |
DocValuesTermsCollector<DV> |
(package private) class |
GlobalOrdinalsCollector
A collector that collects all ordinals from a specified field matching the query.
|
(package private) class |
GlobalOrdinalsWithScoreCollector |
(package private) static class |
GlobalOrdinalsWithScoreCollector.Avg |
(package private) static class |
GlobalOrdinalsWithScoreCollector.Max |
(package private) static class |
GlobalOrdinalsWithScoreCollector.Min |
(package private) static class |
GlobalOrdinalsWithScoreCollector.NoScore |
(package private) static class |
GlobalOrdinalsWithScoreCollector.Sum |
(package private) class |
TermsCollector<DV>
A collector that collects all terms from a specified field matching the query.
|
(package private) static class |
TermsCollector.MV |
(package private) static class |
TermsCollector.SV |
(package private) class |
TermsWithScoreCollector<DV> |
(package private) static class |
TermsWithScoreCollector.MV |
(package private) static class |
TermsWithScoreCollector.MV.Avg |
(package private) static class |
TermsWithScoreCollector.SV |
(package private) static class |
TermsWithScoreCollector.SV.Avg |
class |
ToParentBlockJoinCollector
Collects parent document hits for a Query containing one more more
BlockJoinQuery clauses, sorted by the
specified parent Sort.
|
Modifier and Type | Method and Description |
---|---|
protected void |
ToParentBlockJoinIndexSearcher.search(java.util.List<LeafReaderContext> leaves,
Weight weight,
Collector collector) |