Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class TermsCollector<DV>

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.apache.lucene.search.join.DocValuesTermsCollector<DV>

org.apache.lucene.search.join.TermsCollector<DV>

All Implemented Interfaces:

Collector, LeafCollector

Direct Known Subclasses:

TermsCollector.MV, TermsCollector.SV

abstract class TermsCollector<DV>
extends DocValuesTermsCollector<DV>

A collector that collects all terms from a specified field matching the query.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TermsCollector.MV
(package private) static class	TermsCollector.SV

Nested classes/interfaces inherited from class org.apache.lucene.search.join.DocValuesTermsCollector

DocValuesTermsCollector.Function<R>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BytesRefHash	collectorTerms

Fields inherited from class org.apache.lucene.search.join.DocValuesTermsCollector

docValues

Constructor Summary

Constructors

Constructor	Description
TermsCollector(DocValuesTermsCollector.Function<DV> docValuesCall)

Method Summary

Modifier and Type	Method	Description
(package private) static TermsCollector<?>	create(String field, boolean multipleValuesPerDocument)	Chooses the right TermsCollector implementation.
BytesRefHash	getCollectorTerms()
ScoreMode	scoreMode()	Indicates what features are required from the scorer.

Methods inherited from class org.apache.lucene.search.join.DocValuesTermsCollector

doSetNextReader, sortedDocValues, sortedSetDocValues

Methods inherited from class org.apache.lucene.search.SimpleCollector

collect, getLeafCollector, setScorer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Methods inherited from interface org.apache.lucene.search.LeafCollector

collect, competitiveIterator, finish

Field Details

collectorTerms

final BytesRefHash collectorTerms

Constructor Details

TermsCollector

TermsCollector(DocValuesTermsCollector.Function<DV> docValuesCall)

Method Details

getCollectorTerms

public BytesRefHash getCollectorTerms()

create

static TermsCollector<?> create(String field,
 boolean multipleValuesPerDocument)

Chooses the right TermsCollector implementation.

Parameters:

field - The field to collect terms for

multipleValuesPerDocument - Whether the field to collect terms for has multiple values per document.

Returns:

a TermsCollector instance

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.