org.apache.lucene.search

Class ConjunctionScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.ConjunctionScorer

Direct Known Subclasses:

BooleanTopLevelScorers.CoordinatingConjunctionScorer

class ConjunctionScorer
extends Scorer

Scorer for conjunctions, sets of queries, all of which are required.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ConjunctionScorer.DocsAndFreqs

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

Scorer.ChildScorer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) float	coord
(package private) ConjunctionDISI	disi
(package private) Scorer[]	scorers

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

weight

Constructor Summary

Constructors

Constructor and Description
ConjunctionScorer(Weight weight, java.util.List<Scorer> required, java.util.List<Scorer> scorers)
ConjunctionScorer(Weight weight, java.util.List<Scorer> required, java.util.List<Scorer> scorers, float coord) Create a new ConjunctionScorer, note that scorers must be a subset of required.

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
int	freq() Returns the freq of this Scorer on the current document
java.util.Collection<Scorer.ChildScorer>	getChildren() Returns child sub-scorers
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

getWeight

Methods inherited from class java.lang.Object

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

Field Detail

disi

final ConjunctionDISI disi

scorers

final Scorer[] scorers

coord

final float coord

Constructor Detail

ConjunctionScorer

ConjunctionScorer(Weight weight,
                  java.util.List<Scorer> required,
                  java.util.List<Scorer> scorers)

ConjunctionScorer

ConjunctionScorer(Weight weight,
                  java.util.List<Scorer> required,
                  java.util.List<Scorer> scorers,
                  float coord)

Create a new ConjunctionScorer, note that scorers must be a subset of required.

Method Detail

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

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

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()

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

freq

public int freq()

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

getChildren

public java.util.Collection<Scorer.ChildScorer> getChildren()

Description copied from class: Scorer

Returns child sub-scorers

Overrides:

getChildren in class Scorer