Field Detail

• weight

  protected final Weight weight

Constructor Detail

• Scorer

  protected Scorer​(Weight weight)

  Constructs a Scorer

  Parameters:

  weight - The scorers Weight.

• Scorer

  @Deprecated
  protected Scorer​(Similarity similarity)

  Deprecated.

  Use Scorer(Weight) instead.
  Constructs a Scorer.

  Parameters:

  similarity - The Similarity implementation used by this scorer.

• Scorer

  @Deprecated
  protected Scorer​(Similarity similarity,
                   Weight weight)

  Deprecated.

  Use Scorer(Weight) instead.
  Constructs a Scorer

  Parameters:

  similarity - The Similarity implementation used by this scorer.

  weight - The scorers Weight

Method Detail

• getSimilarity

  @Deprecated
  public Similarity getSimilarity()

  Deprecated.

  Store any Similarity you might need privately in your implementation instead.
  Returns the Similarity implementation used by this scorer.

• score

  public void score​(Collector collector)
             throws IOException

  Scores and collects all matching documents.

  Parameters:

  collector - The collector to which all matching documents are passed.

  Throws:

  IOException

• score

  protected boolean score​(Collector collector,
                          int max,
                          int firstDocID)
                   throws IOException

  Expert: Collects matching documents in a range. Hook for optimization. Note, firstDocID is added to ensure that DocIdSetIterator.nextDoc() was called before this method.

  NOTE: Because of backwards compatibility, this method is still declared as protected, but it is intended to be public, because it's called from other classes (like BooleanScorer). If you subclass Scorer, you should declare the overridden method as public to ease transition to Lucene 4.0, where it will be public.

  Parameters:

  collector - The collector to which all matching documents are passed.

  max - Do not score documents past this.

  firstDocID - The first document ID (ensures DocIdSetIterator.nextDoc() is called before this method.

  Returns:

  true if more matching documents may remain.

  Throws:

  IOException

• score

  public abstract float score()
                       throws IOException

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

  Throws:

  IOException

• freq

  public float freq()
             throws IOException

  Returns number of matches for the current document. This returns a float (not int) because SloppyPhraseScorer discounts its freq according to how "sloppy" the match was.

  Throws:

  IOException

  WARNING: This API is experimental and might change in incompatible ways in the next release.

• visitScorers

  public void visitScorers​(Scorer.ScorerVisitor<Query,​Query,​Scorer> visitor)

  Expert: call this to gather details for all sub-scorers for this query. This can be used, in conjunction with a custom Collector to gather details about how each sub-query matched the current hit.

  Parameters:

  visitor - a callback executed for each sub-scorer

  WARNING: This API is experimental and might change in incompatible ways in the next release.

• visitSubScorers

  public void visitSubScorers​(Query parent,
                              BooleanClause.Occur relationship,
                              Scorer.ScorerVisitor<Query,​Query,​Scorer> visitor)

  Scorer subclasses should implement this method if the subclass itself contains multiple scorers to support gathering details for sub-scorers via Scorer.ScorerVisitor

  Note: this method will throw UnsupportedOperationException if no associated Weight instance is provided to Scorer(Weight)

  WARNING: This API is experimental and might change in incompatible ways in the next release.