TopTermsRewrite

java.lang.Object

org.apache.lucene.search.MultiTermQuery.RewriteMethod

org.apache.lucene.search.TermCollectingRewrite<B>

org.apache.lucene.search.TopTermsRewrite<B>

Direct Known Subclasses:: MultiTermQuery.TopTermsBlendedFreqScoringRewrite, MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite, MultiTermQuery.TopTermsScoringBooleanQueryRewrite

public abstract class TopTermsRewrite<B> extends TermCollectingRewrite<B>

Base rewrite method for collecting only the top terms via a priority queue.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

(package private) static final class

TopTermsRewrite.ScoreTerm

Nested classes/interfaces inherited from class org.apache.lucene.search.TermCollectingRewrite
TermCollectingRewrite.TermCollector
Field Summary

Fields

Modifier and Type

Field

Description

private static final Comparator<TopTermsRewrite.ScoreTerm>

scoreTermSortByTermComp

private final int

size
Constructor Summary

Constructors

Constructor

Description

TopTermsRewrite(int size)

Create a TopTermsBooleanQueryRewrite for at most size terms.
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object obj)

protected abstract int

getMaxSize()

return the maximum size of the priority queue (for boolean rewrites this is BooleanQuery#getMaxClauseCount).

int

getSize()

return the maximum priority queue size

int

hashCode()

final Query

rewrite(IndexReader reader, MultiTermQuery query)

Methods inherited from class org.apache.lucene.search.TermCollectingRewrite
addClause, addClause, build, collectTerms, getTopLevelBuilder

Methods inherited from class org.apache.lucene.search.MultiTermQuery.RewriteMethod
getTermsEnum

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details
- size
  
  private final int size
- scoreTermSortByTermComp
  
  private static final Comparator<TopTermsRewrite.ScoreTerm> scoreTermSortByTermComp
Constructor Details
- TopTermsRewrite
  
  public TopTermsRewrite(int size)
  
  Create a TopTermsBooleanQueryRewrite for at most size terms.
  NOTE: if IndexSearcher.getMaxClauseCount() is smaller than size, then it will be used instead.
Method Details
- getSize
  
  public int getSize()
  
  return the maximum priority queue size
- getMaxSize
  
  protected abstract int getMaxSize()
  
  return the maximum size of the priority queue (for boolean rewrites this is BooleanQuery#getMaxClauseCount).
- rewrite
  
  public final Query rewrite(IndexReader reader, MultiTermQuery query) throws IOException
  
  Specified by:
  
  rewrite in class MultiTermQuery.RewriteMethod
  
  Throws:
  
  IOException
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object