Module org.apache.lucene.core

Package org.apache.lucene.index

Class MappedMultiFields.MappedMultiTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.index.FilterLeafReader.FilterTerms

org.apache.lucene.index.MappedMultiFields.MappedMultiTerms

Enclosing class:

MappedMultiFields

private static class MappedMultiFields.MappedMultiTerms
extends FilterLeafReader.FilterTerms

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.FilterTerms

in

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
MappedMultiTerms(String field, MergeState mergeState, MultiTerms multiTerms)

Method Summary

Modifier and Type	Method	Description
int	getDocCount()	Returns the number of documents that have at least one term for this field.
long	getSumDocFreq()	Returns the sum of TermsEnum.docFreq() for all terms in this field.
long	getSumTotalTermFreq()	Returns the sum of TermsEnum.totalTermFreq() for all terms in this field.
TermsEnum	iterator()	Returns an iterator that will step through all terms.
long	size()	Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.

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

getStats, hasFreqs, hasOffsets, hasPayloads, hasPositions

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

getMax, getMin, getTerms, intersect

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

MappedMultiTerms

public MappedMultiTerms(String field,
 MergeState mergeState,
 MultiTerms multiTerms)

Method Details

iterator

public TermsEnum iterator()
                   throws IOException

Description copied from class: Terms

Returns an iterator that will step through all terms. This method will not return null.

Overrides:

iterator in class FilterLeafReader.FilterTerms

Throws:

IOException

size

public long size()
          throws IOException

Description copied from class: Terms

Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Overrides:

size in class FilterLeafReader.FilterTerms

Throws:

IOException

getSumTotalTermFreq

public long getSumTotalTermFreq()
                         throws IOException

Description copied from class: Terms

Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Overrides:

getSumTotalTermFreq in class FilterLeafReader.FilterTerms

Throws:

IOException

getSumDocFreq

public long getSumDocFreq()
                   throws IOException

Description copied from class: Terms

Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Overrides:

getSumDocFreq in class FilterLeafReader.FilterTerms

Throws:

IOException

getDocCount

public int getDocCount()
                throws IOException

Description copied from class: Terms

Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Overrides:

getDocCount in class FilterLeafReader.FilterTerms

Throws:

IOException