org.elasticsearch.common.lucene.index

Class FilterableTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.elasticsearch.common.lucene.index.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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.util.BytesRef	current
protected int	currentDocFreq
protected long	currentTotalTermFreq
protected int	docsEnumFlag
protected static int	NOT_FOUND
protected int	numDocs

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
FilterableTermsEnum(org.apache.lucene.index.IndexReader reader, String field, int docsEnumFlag, org.apache.lucene.search.Filter filter)

Method Summary

Modifier and Type	Method and Description
int	docFreq()
org.apache.lucene.index.DocsEnum	docs(org.apache.lucene.util.Bits liveDocs, org.apache.lucene.index.DocsEnum reuse, int flags)
org.apache.lucene.index.DocsAndPositionsEnum	docsAndPositions(org.apache.lucene.util.Bits liveDocs, org.apache.lucene.index.DocsAndPositionsEnum reuse, int flags)
Comparator<org.apache.lucene.util.BytesRef>	getComparator()
int	getNumDocs()
org.apache.lucene.util.BytesRef	next()
long	ord()
org.apache.lucene.index.TermsEnum.SeekStatus	seekCeil(org.apache.lucene.util.BytesRef text)
boolean	seekExact(org.apache.lucene.util.BytesRef text)
void	seekExact(long ord)
org.apache.lucene.util.BytesRef	term()
long	totalTermFreq()

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

attributes, docs, docsAndPositions, seekExact, termState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOT_FOUND

protected static final int NOT_FOUND

See Also:

Constant Field Values

currentDocFreq

protected int currentDocFreq

currentTotalTermFreq

protected long currentTotalTermFreq

current

protected org.apache.lucene.util.BytesRef current

docsEnumFlag

protected final int docsEnumFlag

numDocs

protected int numDocs

Constructor Detail

FilterableTermsEnum

public FilterableTermsEnum(org.apache.lucene.index.IndexReader reader,
                           String field,
                           int docsEnumFlag,
                           @Nullable
                           org.apache.lucene.search.Filter filter)
                    throws IOException

Throws:

IOException

Method Detail

getNumDocs

public int getNumDocs()

term

public org.apache.lucene.util.BytesRef term()
                                     throws IOException

Specified by:

term in class org.apache.lucene.index.TermsEnum

Throws:

IOException

seekExact

public boolean seekExact(org.apache.lucene.util.BytesRef text)
                  throws IOException

Overrides:

seekExact in class org.apache.lucene.index.TermsEnum

Throws:

IOException

docFreq

public int docFreq()
            throws IOException

Specified by:

docFreq in class org.apache.lucene.index.TermsEnum

Throws:

IOException

totalTermFreq

public long totalTermFreq()
                   throws IOException

Specified by:

totalTermFreq in class org.apache.lucene.index.TermsEnum

Throws:

IOException

seekExact

public void seekExact(long ord)
               throws IOException

Specified by:

seekExact in class org.apache.lucene.index.TermsEnum

Throws:

IOException

seekCeil

public org.apache.lucene.index.TermsEnum.SeekStatus seekCeil(org.apache.lucene.util.BytesRef text)
                                                      throws IOException

Specified by:

seekCeil in class org.apache.lucene.index.TermsEnum

Throws:

IOException

ord

public long ord()
         throws IOException

Specified by:

ord in class org.apache.lucene.index.TermsEnum

Throws:

IOException

docs

public org.apache.lucene.index.DocsEnum docs(org.apache.lucene.util.Bits liveDocs,
                                             org.apache.lucene.index.DocsEnum reuse,
                                             int flags)
                                      throws IOException

Specified by:

docs in class org.apache.lucene.index.TermsEnum

Throws:

IOException

docsAndPositions

public org.apache.lucene.index.DocsAndPositionsEnum docsAndPositions(org.apache.lucene.util.Bits liveDocs,
                                                                     org.apache.lucene.index.DocsAndPositionsEnum reuse,
                                                                     int flags)
                                                              throws IOException

Specified by:

docsAndPositions in class org.apache.lucene.index.TermsEnum

Throws:

IOException

next

public org.apache.lucene.util.BytesRef next()
                                     throws IOException

Throws:

IOException

getComparator

public Comparator<org.apache.lucene.util.BytesRef> getComparator()