Field Detail

• query

  protected final Q extends MultiTermQuery query

Constructor Detail

• MultiTermQueryWrapperFilter

  protected MultiTermQueryWrapperFilter​(Q query)

  Wrap a MultiTermQuery as a Filter.

Method Detail

• toString

  public String toString()

  Overrides:

  toString in class Object

• equals

  public final boolean equals​(Object o)

  Overrides:

  equals in class Object

• hashCode

  public final int hashCode()

  Overrides:

  hashCode in class Object

• getTotalNumberOfTerms

  @Deprecated
  public int getTotalNumberOfTerms()

  Deprecated.

  Don't use this method, as its not thread safe and useless.
  Expert: Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index.

  This method is not thread safe, be sure to only call it when no filter is running! If you re-use the same filter instance for another search, be sure to first reset the term counter with clearTotalNumberOfTerms().

  See Also:

  clearTotalNumberOfTerms()

• clearTotalNumberOfTerms

  @Deprecated
  public void clearTotalNumberOfTerms()

  Deprecated.

  Don't use this method, as its not thread safe and useless.
  Expert: Resets the counting of unique terms. Do this before executing the filter.

  See Also:

  getTotalNumberOfTerms()

• getDocIdSet

  public DocIdSet getDocIdSet​(IndexReader reader)
                       throws IOException

  Returns a DocIdSet with documents that should be permitted in search results.

  Specified by:

  getDocIdSet in class Filter

  Parameters:

  reader - a IndexReader instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment.

  Returns:

  a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.

  Throws:

  IOException

  See Also:

  DocIdBitSet