Package org.apache.lucene.queries

Class TermsFilter

  • public final class TermsFilter
extends Filter
    Constructs a filter for docs matching any of the terms added to this class. Unlike a RangeFilter this can be used for filtering on multiple terms that are not necessarily in a sequence. An example might be a collection of primary keys from a database query result or perhaps a choice of "category" labels picked by the end user. As a filter, this is much faster than the equivalent query (a BooleanQuery with many "should" TermQueries)

    • Constructor Detail

      • TermsFilter

        public TermsFilter​(java.util.List<Term> terms)
        Creates a new TermsFilter from the given list. The list can contain duplicate terms and multiple fields.

      • TermsFilter

        public TermsFilter​(java.lang.String field,
                   java.util.List<BytesRef> terms)
        Creates a new TermsFilter from the given BytesRef list for a single field.

      • TermsFilter

        public TermsFilter​(java.lang.String field,
                   BytesRef... terms)
        Creates a new TermsFilter from the given BytesRef array for a single field.

      • TermsFilter

        public TermsFilter​(Term... terms)
        Creates a new TermsFilter from the given array. The array can contain duplicate terms and multiple fields.

    • Method Detail

      • getDocIdSet

        public DocIdSet getDocIdSet​(AtomicReaderContext context,
                            Bits acceptDocs)
                     throws java.io.IOException
        Description copied from class: Filter
        Creates a DocIdSet enumerating the documents that should be permitted in search results. NOTE: null can be returned if no documents are accepted by this Filter.

        Note: This method will be called once per segment in the index during searching. The returned DocIdSet must refer to document IDs for that segment, not for the top-level reader.

        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:
        java.io.IOException

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object