Package org.apache.lucene.codecs
Class BlockTreeTermsReader.FieldReader
java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.codecs.BlockTreeTermsReader.FieldReader
- Enclosing class:
- BlockTreeTermsReader
BlockTree's implementation of
Terms
.-
Field Summary
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
Method Summary
Modifier and TypeMethodDescriptionFor debugging -- used by CheckIndex tooReturn the BytesRef Comparator used to sort terms provided by the iterator.int
Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec.long
Returns the sum ofTermsEnum.docFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec.long
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).boolean
hasFreqs()
Returns true if documents in this field store per-document term frequency (DocsEnum.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.intersect
(CompiledAutomaton compiled, BytesRef startTerm) Returns a TermsEnum that iterates over all terms that are accepted by the providedCompiledAutomaton
.Returns an iterator that will step through all terms.long
Returns approximate RAM bytes usedlong
size()
Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
-
Method Details
-
computeStats
For debugging -- used by CheckIndex too- Throws:
IOException
-
getComparator
Description copied from class:Terms
Return the BytesRef Comparator used to sort terms provided by the iterator. This method may return null if there are no terms. This method may be invoked many times; it's best to cache a single instance & reuse it.- Specified by:
getComparator
in classTerms
-
hasFreqs
public boolean hasFreqs()Description copied from class:Terms
Returns true if documents in this field store per-document term frequency (DocsEnum.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. If you have a previous TermsEnum, for example from a different field, you can pass it for possible reuse if the implementation can do so.- 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, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions). 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, 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:
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, 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:
getDocCount
in classTerms
-
intersect
Description copied from class:Terms
Returns a TermsEnum that iterates over all terms that are accepted by the providedCompiledAutomaton
. If thestartTerm
is provided then the returned enum will only accept 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.NOTE: the returned TermsEnum cannot seek
.- Overrides:
intersect
in classTerms
- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()Returns approximate RAM bytes used
-