Package org.apache.lucene.search

Class MultiTermQueryWrapperFilter<Q extends MultiTermQuery>

java.lang.Object
org.apache.lucene.search.Filter
org.apache.lucene.search.MultiTermQueryWrapperFilter<Q>
Direct Known Subclasses:
NumericRangeFilter, PrefixFilter, TermRangeFilter
public class MultiTermQueryWrapperFilter<Q extends MultiTermQuery> extends Filter
A wrapper for MultiTermQuery, that exposes its functionality as a Filter.

MultiTermQueryWrapperFilter is not designed to be used by itself. Normally you subclass it to provide a Filter counterpart for a MultiTermQuery subclass.

For example, TermRangeFilter and PrefixFilter extend MultiTermQueryWrapperFilter. This class also provides the functionality behind MultiTermQuery.CONSTANT_SCORE_FILTER_REWRITE; this is why it is not abstract.

  • Method Details

    • 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

    • getField

      public final String getField()
      Returns the field name for this query

    • getDocIdSet

      public DocIdSet getDocIdSet(AtomicReaderContext context, Bits acceptDocs) throws IOException
      Returns a DocIdSet with documents that should be permitted in search results.
      Specified by:
      getDocIdSet in class Filter
      Parameters:
      context - a AtomicReaderContext instance opened on the index currently searched on. Note, it is likely that the provided reader info 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. The provided context is always an atomic context, so you can call AtomicReader.fields() on the context's reader, for example.
      acceptDocs - Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)
      Returns:
      a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null should be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an empty DocIdSet is returned.
      Throws:
      IOException