org.apache.lucene.search
Class ReqExclScorer

java.lang.Object
  extended byorg.apache.lucene.search.Scorer
      extended byorg.apache.lucene.search.ReqExclScorer

public class ReqExclScorer
extends Scorer

A Scorer for queries with a required subscorer and an excluding (prohibited) subscorer.
This Scorer implements Scorer.skipTo(int), and it uses the skipTo() on the given scorers.


Constructor Summary
ReqExclScorer(Scorer reqScorer, Scorer exclScorer)
          Construct a ReqExclScorer.
 
Method Summary
 int doc()
          Returns the current document number matching the query.
 Explanation explain(int doc)
          Returns an explanation of the score for a document.
 boolean next()
          Advances to the next document matching the query.
 float score()
          Returns the score of the current document matching the query.
 boolean skipTo(int target)
          Skips to the first match beyond the current whose document number is greater than or equal to a given target.
 
Methods inherited from class org.apache.lucene.search.Scorer
getSimilarity, score, score
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReqExclScorer

public ReqExclScorer(Scorer reqScorer,
                     Scorer exclScorer)
Construct a ReqExclScorer.

Parameters:
reqScorer - The scorer that must match, except where
exclScorer - indicates exclusion.
Method Detail

next

public boolean next()
             throws IOException
Description copied from class: Scorer
Advances to the next document matching the query.

Specified by:
next in class Scorer
Returns:
true iff there is another document matching the query.
When this method is used the Scorer.explain(int) method should not be used.
Throws:
IOException

doc

public int doc()
Description copied from class: Scorer
Returns the current document number matching the query. Initially invalid, until Scorer.next() is called the first time.

Specified by:
doc in class Scorer

score

public float score()
            throws IOException
Returns the score of the current document matching the query. Initially invalid, until next() is called the first time.

Specified by:
score in class Scorer
Returns:
The score of the required scorer.
Throws:
IOException

skipTo

public boolean skipTo(int target)
               throws IOException
Skips to the first match beyond the current whose document number is greater than or equal to a given target.
When this method is used the explain(int) method should not be used.

Specified by:
skipTo in class Scorer
Parameters:
target - The target document number.
Returns:
true iff there is such a match.
Throws:
IOException

explain

public Explanation explain(int doc)
                    throws IOException
Description copied from class: Scorer
Returns an explanation of the score for a document.
When this method is used, the Scorer.next(), Scorer.skipTo(int) and Scorer.score(HitCollector) methods should not be used.

Specified by:
explain in class Scorer
Parameters:
doc - The document number for the explanation.
Throws:
IOException


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.