org.apache.lucene.search.join

Class BaseGlobalOrdinalScorer

java.lang.Object

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.Scorer

Scorer.ChildScorer

Field Summary

Fields

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

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

weight

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract TwoPhaseIterator	createTwoPhaseIterator(DocIdSetIterator approximation)
int	docID() Returns the doc ID that is currently being scored.
int	freq() Returns the freq of this Scorer on the current document
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

getChildren, getWeight

Methods inherited from class java.lang.Object

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

Field Detail

values

final SortedDocValues values

approximation

final DocIdSetIterator approximation

score

float score

Constructor Detail

BaseGlobalOrdinalScorer

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

Method Detail

score

public float score()
            throws java.io.IOException

Description copied from class: Scorer

Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) is called on the Scorer.iterator() the first time, or when called from within LeafCollector.collect(int).

Specified by:

score in class Scorer

Throws:

java.io.IOException

docID

public int docID()

Description copied from class: Scorer

Returns the doc ID that is currently being scored. This will return -1 if the Scorer.iterator() is not positioned or DocIdSetIterator.NO_MORE_DOCS if it has been entirely consumed.

Specified by:

docID in class Scorer

See Also:

DocIdSetIterator.docID()

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

freq

public int freq()
         throws java.io.IOException

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

Throws:

java.io.IOException

createTwoPhaseIterator

protected abstract TwoPhaseIterator createTwoPhaseIterator(DocIdSetIterator approximation)