Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class TermsWithScoreCollector<DV>

java.lang.Object

org.apache.lucene.search.SimpleCollector

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

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

All Implemented Interfaces:

Collector, GenericTermsCollector, LeafCollector

Direct Known Subclasses:

TermsWithScoreCollector.MV, TermsWithScoreCollector.SV

abstract class TermsWithScoreCollector<DV>
extends DocValuesTermsCollector<DV>
implements GenericTermsCollector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TermsWithScoreCollector.MV
(package private) static class	TermsWithScoreCollector.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	collectedTerms
private static final int	INITIAL_ARRAY_SIZE
(package private) final ScoreMode	scoreMode
(package private) Scorable	scorer
(package private) float[]	scoreSums

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

docValues

Constructor Summary

Constructors

Constructor	Description
TermsWithScoreCollector(DocValuesTermsCollector.Function<DV> docValuesCall, ScoreMode scoreMode)

Method Summary

Modifier and Type	Method	Description
(package private) static TermsWithScoreCollector<?>	create(String field, boolean multipleValuesPerDocument, ScoreMode scoreMode)	Chooses the right TermsWithScoreCollector implementation.
BytesRefHash	getCollectedTerms()
float[]	getScoresPerTerm()
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
void	setScorer(Scorable scorer)	Called before successive calls to LeafCollector.collect(int).

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

doSetNextReader, sortedDocValues, sortedSetDocValues

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

collect, getLeafCollector

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

getLeafCollector, setWeight

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

collect, competitiveIterator, finish

Field Details

INITIAL_ARRAY_SIZE

private static final int INITIAL_ARRAY_SIZE

See Also:

• Constant Field Values

collectedTerms

final BytesRefHash collectedTerms

scoreMode

final ScoreMode scoreMode

scorer

Scorable scorer

scoreSums

float[] scoreSums

Constructor Details

TermsWithScoreCollector

TermsWithScoreCollector(DocValuesTermsCollector.Function<DV> docValuesCall,
 ScoreMode scoreMode)

Method Details

getCollectedTerms

public BytesRefHash getCollectedTerms()

Specified by:

getCollectedTerms in interface GenericTermsCollector

getScoresPerTerm

public float[] getScoresPerTerm()

Specified by:

getScoresPerTerm in interface GenericTermsCollector

setScorer

public void setScorer(Scorable scorer)
               throws IOException

Description copied from interface: LeafCollector

Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in interface LeafCollector

Overrides:

setScorer in class SimpleCollector

Throws:

IOException

create

static TermsWithScoreCollector<?> create(String field,
 boolean multipleValuesPerDocument,
 ScoreMode scoreMode)

Chooses the right TermsWithScoreCollector implementation.

Parameters:

field - The field to collect terms for

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

Returns:

a TermsWithScoreCollector instance

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

Specified by:

scoreMode in interface Collector