Module org.apache.lucene.sandbox
Class VersionFieldReader
java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.sandbox.codecs.idversion.VersionFieldReader
BlockTree's implementation of
Terms
.-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
(package private) final FieldInfo
(package private) final FST
<PairOutputs.Pair<BytesRef, Long>> (package private) final long
(package private) final BytesRef
(package private) final BytesRef
(package private) final long
(package private) final VersionBlockTreeTermsReader
(package private) final long
(package private) final PairOutputs.Pair
<BytesRef, Long> (package private) final long
(package private) final long
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionVersionFieldReader
(VersionBlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, PairOutputs.Pair<BytesRef, Long> rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, IndexInput indexIn, BytesRef minTerm, BytesRef maxTerm) -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of documents that have at least one term for this field.getMax()
Returns the largest term (in lexicographic order) in the field.getMin()
Returns the smallest term (in lexicographic order) in the 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
size()
Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.toString()
-
Field Details
-
numTerms
final long numTerms -
fieldInfo
-
sumTotalTermFreq
final long sumTotalTermFreq -
sumDocFreq
final long sumDocFreq -
docCount
final int docCount -
indexStartFP
final long indexStartFP -
rootBlockFP
final long rootBlockFP -
rootCode
-
minTerm
-
maxTerm
-
parent
-
index
-
-
Constructor Details
-
VersionFieldReader
VersionFieldReader(VersionBlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, PairOutputs.Pair<BytesRef, Long> rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, IndexInput indexIn, BytesRef minTerm, BytesRef maxTerm) throws IOException- Throws:
IOException
-
-
Method Details
-
getMin
Description copied from class:Terms
Returns the smallest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Overrides:
getMin
in classTerms
- Throws:
IOException
-
getMax
Description copied from class:Terms
Returns the largest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Overrides:
getMax
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
-
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
-
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
public long 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
-
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 classTerms
-
toString
-