Package org.elasticsearch.common.lucene.index

Class FreqTermsEnum

java.lang.Object
org.apache.lucene.index.TermsEnum
org.elasticsearch.common.lucene.index.FilterableTermsEnum
org.elasticsearch.common.lucene.index.FreqTermsEnum
All Implemented Interfaces:
java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.util.BytesRefIterator, Releasable
public class FreqTermsEnum
extends FilterableTermsEnum
implements Releasable
A frequency terms enum that maintains a cache of docFreq, totalTermFreq, or both for repeated term lookup.

  • Nested Class Summary

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

    org.apache.lucene.index.TermsEnum.SeekStatus

  • Field Summary

    Fields inherited from class org.elasticsearch.common.lucene.index.FilterableTermsEnum

    current, currentDocFreq, currentTotalTermFreq, docsEnumFlag, NOT_FOUND

    Fields inherited from class org.apache.lucene.index.TermsEnum

    EMPTY

  • Constructor Summary

    Constructors 
    Constructor Description
    FreqTermsEnum​(org.apache.lucene.index.IndexReader reader, java.lang.String field, boolean needDocFreq, boolean needTotalTermFreq, org.apache.lucene.search.Query filter, BigArrays bigArrays)  

  • Method Summary

    Modifier and Type Method Description
    void close()  
    boolean seekExact​(org.apache.lucene.util.BytesRef text)  

    Methods inherited from class org.elasticsearch.common.lucene.index.FilterableTermsEnum

    attributes, docFreq, impacts, next, ord, postings, seekCeil, seekExact, seekExact, term, termState, 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

  • Constructor Details

    • FreqTermsEnum

      public FreqTermsEnum​(org.apache.lucene.index.IndexReader reader, java.lang.String field, boolean needDocFreq, boolean needTotalTermFreq, @Nullable org.apache.lucene.search.Query filter, BigArrays bigArrays) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • seekExact

      public boolean seekExact​(org.apache.lucene.util.BytesRef text) throws java.io.IOException
      Overrides:
      seekExact in class FilterableTermsEnum
      Throws:
      java.io.IOException

    • close

      public void close()
      Specified by:
      close in interface java.lang.AutoCloseable
      Specified by:
      close in interface java.io.Closeable
      Specified by:
      close in interface Releasable