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:

Closeable, AutoCloseable, 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

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(IndexReader reader, String field, boolean needDocFreq, boolean needTotalTermFreq, Query filter, BigArrays bigArrays)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	seekExact(BytesRef text)	Attempts to seek to the exact term, returning true if the term is found.

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 Detail

FreqTermsEnum

public FreqTermsEnum(IndexReader reader,
                     String field,
                     boolean needDocFreq,
                     boolean needTotalTermFreq,
                     @Nullable
                     Query filter,
                     BigArrays bigArrays)
              throws IOException

Throws:

IOException

Method Detail

seekExact

public boolean seekExact(BytesRef text)
                  throws IOException

Description copied from class: TermsEnum

Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Overrides:

seekExact in class FilterableTermsEnum

Returns:

true if the term is found; return false if the enum is unpositioned.

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable