Module org.apache.lucene.core

Package org.apache.lucene.index

Class MappedMultiFields.MappedMultiTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.FilterLeafReader.FilterTermsEnum

org.apache.lucene.index.MappedMultiFields.MappedMultiTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

MappedMultiFields

private static class MappedMultiFields.MappedMultiTermsEnum
extends FilterLeafReader.FilterTermsEnum

Nested Class Summary

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

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String	field
(package private) final MergeState	mergeState

Fields inherited from class org.apache.lucene.index.FilterLeafReader.FilterTermsEnum

in

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
MappedMultiTermsEnum(String field, MergeState mergeState, MultiTermsEnum multiTermsEnum)

Method Summary

Modifier and Type	Method	Description
int	docFreq()	Returns the number of documents containing the current term.
PostingsEnum	postings(PostingsEnum reuse, int flags)	Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required.
long	totalTermFreq()	Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).

Methods inherited from class org.apache.lucene.index.FilterLeafReader.FilterTermsEnum

attributes, impacts, next, ord, seekCeil, seekExact, seekExact, seekExact, term, termState

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 Details

mergeState

final MergeState mergeState

field

final String field

Constructor Details

MappedMultiTermsEnum

public MappedMultiTermsEnum(String field,
 MergeState mergeState,
 MultiTermsEnum multiTermsEnum)

Method Details

docFreq

public int docFreq()
            throws IOException

Description copied from class: TermsEnum

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. TermsEnum.SeekStatus.END.

Overrides:

docFreq in class FilterLeafReader.FilterTermsEnum

Throws:

IOException

totalTermFreq

public long totalTermFreq()
                   throws IOException

Description copied from class: TermsEnum

Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.

Overrides:

totalTermFreq in class FilterLeafReader.FilterTermsEnum

Throws:

IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
 int flags)
                      throws IOException

Description copied from class: TermsEnum

Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method will not return null.

NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the PostingsEnum.

Overrides:

postings in class FilterLeafReader.FilterTermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

Throws:

IOException