Module org.apache.lucene.codecs
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate final class
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
(package private) final FieldInfo
(package private) final long
(package private) final long
(package private) final long
(package private) final long
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
ConstructorsConstructorDescriptionFieldReader
(FieldInfo fieldInfo, long numTerms, long termsStartPointer, long sumTotalTermFreq, long sumDocFreq, int docCount) -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of documents that have at least one term for this field.long
Returns the sum ofTermsEnum.docFreq()
for all terms in this field.long
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field.boolean
hasFreqs()
Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()
).boolean
Returns true if documents in this field store offsets.boolean
Returns true if documents in this field store payloads.boolean
Returns true if documents in this field store positions.iterator()
Returns an iterator that will step through all terms.long
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
-
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 interfaceAccountable
-
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 classTerms
- 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()
). -
hasOffsets
public boolean hasOffsets()Description copied from class:Terms
Returns true if documents in this field store offsets.- Specified by:
hasOffsets
in classTerms
-
hasPositions
public boolean hasPositions()Description copied from class:Terms
Returns true if documents in this field store positions.- Specified by:
hasPositions
in classTerms
-
hasPayloads
public boolean hasPayloads()Description copied from class:Terms
Returns true if documents in this field store payloads.- Specified by:
hasPayloads
in classTerms
-
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. -
getSumTotalTermFreq
public long getSumTotalTermFreq()Description copied from class:Terms
Returns the sum ofTermsEnum.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 classTerms
-
getSumDocFreq
Description copied from class:Terms
Returns the sum ofTermsEnum.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 classTerms
- Throws:
IOException
-
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 classTerms
- Throws:
IOException
-