Class FieldReader
- java.lang.Object
-
- org.apache.lucene.index.Terms
-
- org.apache.lucene.codecs.blocktree.FieldReader
-
- All Implemented Interfaces:
Accountable
public final class FieldReader extends Terms implements Accountable
BlockTree's implementation ofTerms
.
-
-
Field Summary
Fields Modifier and Type Field Description private static long
BASE_RAM_BYTES_USED
(package private) int
docCount
(package private) FieldInfo
fieldInfo
(package private) FST<BytesRef>
index
(package private) BytesRef
maxTerm
(package private) BytesRef
minTerm
(package private) long
numTerms
(package private) BlockTreeTermsReader
parent
(package private) long
rootBlockFP
(package private) BytesRef
rootCode
(package private) long
sumDocFreq
(package private) long
sumTotalTermFreq
-
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Constructor Description FieldReader(BlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, BytesRef rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, IndexInput metaIn, IndexInput indexIn, BytesRef minTerm, BytesRef maxTerm)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Collection<Accountable>
getChildResources()
Returns nested resources of this class.int
getDocCount()
Returns the number of documents that have at least one term for this field.BytesRef
getMax()
Returns the largest term (in lexicographic order) in the field.BytesRef
getMin()
Returns the smallest term (in lexicographic order) in the field.Stats
getStats()
For debugging -- used by CheckIndex toolong
getSumDocFreq()
Returns the sum ofTermsEnum.docFreq()
for all terms in this field.long
getSumTotalTermFreq()
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
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
intersect(CompiledAutomaton compiled, BytesRef startTerm)
Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton
.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.java.lang.String
toString()
-
-
-
Field Detail
-
BASE_RAM_BYTES_USED
private static final long BASE_RAM_BYTES_USED
-
numTerms
final long numTerms
-
fieldInfo
final FieldInfo fieldInfo
-
sumTotalTermFreq
final long sumTotalTermFreq
-
sumDocFreq
final long sumDocFreq
-
docCount
final int docCount
-
rootBlockFP
final long rootBlockFP
-
rootCode
final BytesRef rootCode
-
minTerm
final BytesRef minTerm
-
maxTerm
final BytesRef maxTerm
-
parent
final BlockTreeTermsReader parent
-
-
Constructor Detail
-
FieldReader
FieldReader(BlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, BytesRef rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, IndexInput metaIn, IndexInput indexIn, BytesRef minTerm, BytesRef maxTerm) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
getMin
public BytesRef getMin() throws java.io.IOException
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.
-
getMax
public BytesRef getMax() throws java.io.IOException
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.
-
getStats
public Stats getStats() throws java.io.IOException
For debugging -- used by CheckIndex too
-
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
public TermsEnum iterator() throws java.io.IOException
Description copied from class:Terms
Returns an iterator that will step through all terms. This method will not return null.
-
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
-
intersect
public TermsEnum intersect(CompiledAutomaton compiled, BytesRef startTerm) throws java.io.IOException
Description copied from class:Terms
Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton
. If thestartTerm
is provided then the returned enum will only return terms> startTerm
, but you still must call next() first to get to the first term. Note that the providedstartTerm
must be accepted by the automaton.This is an expert low-level API and will only work for
NORMAL
compiled automata. To handle any compiled automata you should instead useCompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms)
instead.NOTE: the returned TermsEnum cannot seek
.
-
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
-
getChildResources
public java.util.Collection<Accountable> getChildResources()
Description copied from interface:Accountable
Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).- Specified by:
getChildResources
in interfaceAccountable
- See Also:
Accountables
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-