org.apache.lucene.index

Class FreqProxFields.FreqProxTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.index.FreqProxFields.FreqProxTerms

Enclosing class:

FreqProxFields

private static class FreqProxFields.FreqProxTerms
extends Terms

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FreqProxTermsWriterPerField	terms

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
FreqProxTerms(FreqProxTermsWriterPerField terms)

Method Summary

Modifier and Type	Method and 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.
boolean	hasFreqs() Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
boolean	hasOffsets() Returns true if documents in this field store offsets.
boolean	hasPayloads() Returns true if documents in this field store payloads.
boolean	hasPositions() Returns true if documents in this field store positions.
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.Terms

getMax, getMin, getStats, intersect

Methods inherited from class java.lang.Object

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

Field Detail

terms

final FreqProxTermsWriterPerField terms

Constructor Detail

FreqProxTerms

public FreqProxTerms(FreqProxTermsWriterPerField terms)

Method Detail

iterator

public TermsEnum iterator()

Description copied from class: Terms

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

Specified by:

iterator in class Terms

size

public long size()

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.

Specified by:

size in class Terms

getSumTotalTermFreq

public long getSumTotalTermFreq()

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.

Specified by:

getSumTotalTermFreq in class Terms

getSumDocFreq

public long getSumDocFreq()

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.

Specified by:

getSumDocFreq in class Terms

getDocCount

public int getDocCount()

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.

Specified by:

getDocCount in class Terms

hasFreqs

public boolean hasFreqs()

Description copied from class: Terms

Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).

Specified by:

hasFreqs in class Terms

hasOffsets

public boolean hasOffsets()

Description copied from class: Terms

Returns true if documents in this field store offsets.

Specified by:

hasOffsets in class Terms

hasPositions

public boolean hasPositions()

Description copied from class: Terms

Returns true if documents in this field store positions.

Specified by:

hasPositions in class Terms

hasPayloads

public boolean hasPayloads()

Description copied from class: Terms

Returns true if documents in this field store payloads.

Specified by:

hasPayloads in class Terms