Class FilterableTermsEnum

  • All Implemented Interfaces:
    org.apache.lucene.util.BytesRefIterator
    Direct Known Subclasses:
    FreqTermsEnum

    public class FilterableTermsEnum
    extends org.apache.lucene.index.TermsEnum
    A frequency TermsEnum that returns frequencies derived from a collection of cached leaf termEnums. It also allows to provide a filter to explicitly compute frequencies only for docs that match the filter (heavier!).
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

        org.apache.lucene.index.TermsEnum.SeekStatus
    • Constructor Summary

      Constructors 
      Constructor Description
      FilterableTermsEnum​(org.apache.lucene.index.IndexReader reader, java.lang.String field, int docsEnumFlag, org.apache.lucene.search.Query filter)  
    • Method Summary

      Modifier and Type Method Description
      org.apache.lucene.util.AttributeSource attributes()  
      int docFreq()  
      org.apache.lucene.index.ImpactsEnum impacts​(int flags)  
      org.apache.lucene.util.BytesRef next()  
      long ord()  
      org.apache.lucene.index.PostingsEnum postings​(org.apache.lucene.index.PostingsEnum reuse, int flags)  
      org.apache.lucene.index.TermsEnum.SeekStatus seekCeil​(org.apache.lucene.util.BytesRef text)  
      void seekExact​(long ord)  
      boolean seekExact​(org.apache.lucene.util.BytesRef text)  
      void seekExact​(org.apache.lucene.util.BytesRef term, org.apache.lucene.index.TermState state)  
      org.apache.lucene.util.BytesRef term()  
      org.apache.lucene.index.TermState termState()  
      long totalTermFreq()  
      • Methods inherited from class org.apache.lucene.index.TermsEnum

        postings
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • currentDocFreq

        protected int currentDocFreq
      • currentTotalTermFreq

        protected long currentTotalTermFreq
      • current

        protected org.apache.lucene.util.BytesRef current
      • docsEnumFlag

        protected final int docsEnumFlag
    • Constructor Detail

      • FilterableTermsEnum

        public FilterableTermsEnum​(org.apache.lucene.index.IndexReader reader,
                                   java.lang.String field,
                                   int docsEnumFlag,
                                   @Nullable
                                   org.apache.lucene.search.Query filter)
                            throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • term

        public org.apache.lucene.util.BytesRef term()
                                             throws java.io.IOException
        Specified by:
        term in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • attributes

        public org.apache.lucene.util.AttributeSource attributes()
        Specified by:
        attributes in class org.apache.lucene.index.TermsEnum
      • seekExact

        public boolean seekExact​(org.apache.lucene.util.BytesRef text)
                          throws java.io.IOException
        Specified by:
        seekExact in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • docFreq

        public int docFreq()
                    throws java.io.IOException
        Specified by:
        docFreq in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • totalTermFreq

        public long totalTermFreq()
                           throws java.io.IOException
        Specified by:
        totalTermFreq in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • seekExact

        public void seekExact​(long ord)
                       throws java.io.IOException
        Specified by:
        seekExact in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • seekExact

        public void seekExact​(org.apache.lucene.util.BytesRef term,
                              org.apache.lucene.index.TermState state)
                       throws java.io.IOException
        Specified by:
        seekExact in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • termState

        public org.apache.lucene.index.TermState termState()
                                                    throws java.io.IOException
        Specified by:
        termState in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • seekCeil

        public org.apache.lucene.index.TermsEnum.SeekStatus seekCeil​(org.apache.lucene.util.BytesRef text)
                                                              throws java.io.IOException
        Specified by:
        seekCeil in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • ord

        public long ord()
                 throws java.io.IOException
        Specified by:
        ord in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • postings

        public org.apache.lucene.index.PostingsEnum postings​(org.apache.lucene.index.PostingsEnum reuse,
                                                             int flags)
                                                      throws java.io.IOException
        Specified by:
        postings in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • impacts

        public org.apache.lucene.index.ImpactsEnum impacts​(int flags)
                                                    throws java.io.IOException
        Specified by:
        impacts in class org.apache.lucene.index.TermsEnum
        Throws:
        java.io.IOException
      • next

        public org.apache.lucene.util.BytesRef next()
                                             throws java.io.IOException
        Throws:
        java.io.IOException