Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class GlobalOrdinalsWithScoreCollector

java.lang.Object

org.apache.lucene.search.join.GlobalOrdinalsWithScoreCollector

All Implemented Interfaces:

Collector

Direct Known Subclasses:

GlobalOrdinalsWithScoreCollector.Avg, GlobalOrdinalsWithScoreCollector.Max, GlobalOrdinalsWithScoreCollector.Min, GlobalOrdinalsWithScoreCollector.NoScore, GlobalOrdinalsWithScoreCollector.Sum

abstract class GlobalOrdinalsWithScoreCollector
extends Object
implements Collector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	GlobalOrdinalsWithScoreCollector.Avg
(package private) static final class	GlobalOrdinalsWithScoreCollector.Max
(package private) static final class	GlobalOrdinalsWithScoreCollector.Min
(package private) static final class	GlobalOrdinalsWithScoreCollector.NoScore
(package private) static final class	GlobalOrdinalsWithScoreCollector.Occurrences
(package private) final class	GlobalOrdinalsWithScoreCollector.OrdinalMapCollector
(package private) static final class	GlobalOrdinalsWithScoreCollector.Scores
(package private) final class	GlobalOrdinalsWithScoreCollector.SegmentOrdinalCollector
(package private) static final class	GlobalOrdinalsWithScoreCollector.Sum

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	arraySize
(package private) final LongBitSet	collectedOrds
(package private) final boolean	doMinMax
(package private) final String	field
(package private) final int	max
(package private) final int	min
protected final GlobalOrdinalsWithScoreCollector.Occurrences	occurrences
(package private) final OrdinalMap	ordinalMap
protected final GlobalOrdinalsWithScoreCollector.Scores	scores

Constructor Summary

Constructors

Constructor	Description
GlobalOrdinalsWithScoreCollector(String field, OrdinalMap ordinalMap, long valueCount, ScoreMode scoreMode, int min, int max)

Method Summary

Modifier and Type	Method	Description
protected abstract void	doScore(int globalOrd, float existingScore, float newScore)
LeafCollector	getLeafCollector(LeafReaderContext context)	Create a new collector to collect the given context.
boolean	match(int globalOrd)
float	score(int globalOrdinal)
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
protected abstract float	unset()

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

Field Details

field

final String field

doMinMax

final boolean doMinMax

min

final int min

max

final int max

ordinalMap

final OrdinalMap ordinalMap

collectedOrds

final LongBitSet collectedOrds

scores

protected final GlobalOrdinalsWithScoreCollector.Scores scores

occurrences

protected final GlobalOrdinalsWithScoreCollector.Occurrences occurrences

arraySize

static final int arraySize

See Also:

• Constant Field Values

Constructor Details

GlobalOrdinalsWithScoreCollector

GlobalOrdinalsWithScoreCollector(String field,
 OrdinalMap ordinalMap,
 long valueCount,
 ScoreMode scoreMode,
 int min,
 int max)

Method Details

match

public boolean match(int globalOrd)

score

public float score(int globalOrdinal)

doScore

protected abstract void doScore(int globalOrd,
 float existingScore,
 float newScore)

unset

protected abstract float unset()

getLeafCollector

public LeafCollector getLeafCollector(LeafReaderContext context)
                               throws IOException

Description copied from interface: Collector

Create a new collector to collect the given context.

Specified by:

getLeafCollector in interface Collector

Parameters:

context - next atomic reader context

Throws:

IOException

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

Specified by:

scoreMode in interface Collector