Class RawTermFilter

  • All Implemented Interfaces:
    Serializable

    public class RawTermFilter
    extends Filter
    Expert: creates a filter accepting all documents containing the provided term, disregarding deleted documents. NOTE: this filter only works on readers whose sequential sub readers are SegmentReaders.

    Normally you should not use this class; the only known required case is when using BlockJoinQuery from contrib/join.

    See Also:
    Serialized Form
    WARNING: This API is experimental and might change in incompatible ways in the next release.
    • Constructor Detail

      • RawTermFilter

        public RawTermFilter​(Term term)
    • Method Detail

      • getDocIdSet

        public DocIdSet getDocIdSet​(IndexReader reader)
                             throws 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:
        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