Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class BaseGlobalOrdinalScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.search.join.BaseGlobalOrdinalScorer

Direct Known Subclasses:

GlobalOrdinalsQuery.OrdinalMapScorer, GlobalOrdinalsQuery.SegmentOrdinalScorer, GlobalOrdinalsWithScoreQuery.OrdinalMapScorer, GlobalOrdinalsWithScoreQuery.SegmentOrdinalScorer

abstract class BaseGlobalOrdinalScorer
extends Scorer

Nested Class Summary

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

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final DocIdSetIterator	approximation
(package private) final float	boost
(package private) float	score
(package private) final SortedDocValues	values

Fields inherited from class org.apache.lucene.search.Scorer

weight

Constructor Summary

Constructors

Constructor	Description
BaseGlobalOrdinalScorer(Weight weight, SortedDocValues values, DocIdSetIterator approximationScorer, float boost)

Method Summary

Modifier and Type	Method	Description
protected abstract TwoPhaseIterator	createTwoPhaseIterator(DocIdSetIterator approximation)
int	docID()	Returns the doc ID that is currently being scored.
float	getMaxScore(int upTo)	Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.
DocIdSetIterator	iterator()	Return a DocIdSetIterator over matching documents.
float	score()	Returns the score of the current document matching the query.
TwoPhaseIterator	twoPhaseIterator()	Optional method: Return a TwoPhaseIterator view of this Scorer.

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

advanceShallow, getWeight

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

getChildren, setMinCompetitiveScore, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

values

final SortedDocValues values

approximation

final DocIdSetIterator approximation

boost

final float boost

score

float score

Constructor Details

BaseGlobalOrdinalScorer

public BaseGlobalOrdinalScorer(Weight weight,
 SortedDocValues values,
 DocIdSetIterator approximationScorer,
 float boost)

Method Details

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

Throws:

IOException

getMaxScore

public float getMaxScore(int upTo)
                  throws IOException

Description copied from class: Scorer

Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.

Specified by:

getMaxScore in class Scorer

Throws:

IOException

docID

public int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

Return a DocIdSetIterator over matching documents.

The returned iterator will either be positioned on -1 if no documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS if all documents have been scored already, or the last document id that has been scored otherwise.

The returned iterator is a view: calling this method several times will return iterators that have the same state.

Specified by:

iterator in class Scorer

twoPhaseIterator

public TwoPhaseIterator twoPhaseIterator()

Description copied from class: Scorer

Optional method: Return a TwoPhaseIterator view of this Scorer. A return value of null indicates that two-phase iteration is not supported.

Note that the returned TwoPhaseIterator's approximation must advance synchronously with the Scorer.iterator(): advancing the approximation must advance the iterator and vice-versa.

Implementing this method is typically useful on Scorers that have a high per-document overhead in order to confirm matches.

The default implementation returns null.

Overrides:

twoPhaseIterator in class Scorer

createTwoPhaseIterator

protected abstract TwoPhaseIterator createTwoPhaseIterator(DocIdSetIterator approximation)