Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.blockterms

Class BlockTermsReader.FieldReader

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.codecs.blockterms.BlockTermsReader.FieldReader

All Implemented Interfaces:

Accountable

Enclosing class:

BlockTermsReader

private class BlockTermsReader.FieldReader
extends Terms
implements Accountable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	BlockTermsReader.FieldReader.SegmentTermsEnum

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	docCount
(package private) final FieldInfo	fieldInfo
(package private) final long	numTerms
(package private) final long	sumDocFreq
(package private) final long	sumTotalTermFreq
(package private) final long	termsStartPointer

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

EMPTY_ARRAY

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
FieldReader(FieldInfo fieldInfo, long numTerms, long termsStartPointer, long sumTotalTermFreq, long sumDocFreq, int docCount)

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.
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	ramBytesUsed()	Return the memory usage of this object in bytes.
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, getTerms, intersect

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

numTerms

final long numTerms

fieldInfo

final FieldInfo fieldInfo

termsStartPointer

final long termsStartPointer

sumTotalTermFreq

final long sumTotalTermFreq

sumDocFreq

final long sumDocFreq

docCount

final int docCount

Constructor Details

FieldReader

FieldReader(FieldInfo fieldInfo,
 long numTerms,
 long termsStartPointer,
 long sumTotalTermFreq,
 long sumDocFreq,
 int docCount)

Method Details

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

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.

Specified by:

iterator in class Terms

Throws:

IOException

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

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()
                   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.

Specified by:

getSumDocFreq in class Terms

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.

Specified by:

getDocCount in class Terms

Throws:

IOException