Class BooleanFilter

  • All Implemented Interfaces:
    Serializable, Iterable<FilterClause>

    public class BooleanFilter
    extends org.apache.lucene.search.Filter
    implements Iterable<FilterClause>
    A container Filter that allows Boolean composition of Filters. Filters are allocated into one of three logical constructs; SHOULD, MUST NOT, MUST The results Filter BitSet is constructed as follows: SHOULD Filters are OR'd together The resulting Filter is NOT'd with the NOT Filters The resulting Filter is AND'd with the MUST Filters
    See Also:
    Serialized Form
    • Constructor Detail

      • BooleanFilter

        public BooleanFilter()
    • Method Detail

      • getDocIdSet

        public org.apache.lucene.search.DocIdSet getDocIdSet​(org.apache.lucene.index.IndexReader reader)
                                                      throws IOException
        Returns the a DocIdSetIterator representing the Boolean composition of the filters that have been added.
        Specified by:
        getDocIdSet in class org.apache.lucene.search.Filter
        Throws:
        IOException
      • add

        public void add​(FilterClause filterClause)
        Adds a new FilterClause to the Boolean Filter container
        Parameters:
        filterClause - A FilterClause object containing a Filter and an Occur parameter
      • add

        public final void add​(org.apache.lucene.search.Filter filter,
                              org.apache.lucene.search.BooleanClause.Occur occur)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Prints a user-readable version of this Filter.
        Overrides:
        toString in class Object