Class FieldReader
java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.backward_codecs.lucene40.blocktree.FieldReader
BlockTree's implementation of
Terms
.-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
(package private) final FieldInfo
(package private) final BytesRef
(package private) final BytesRef
(package private) final long
(package private) final Lucene40BlockTreeTermsReader
(package private) final long
(package private) final BytesRef
(package private) final long
(package private) final long
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionFieldReader
(Lucene40BlockTreeTermsReader 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
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.getStats()
For debugging -- used by CheckIndex toolong
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.intersect
(CompiledAutomaton compiled, BytesRef startTerm) Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton
.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 -
rootBlockFP
final long rootBlockFP -
rootCode
-
minTerm
-
maxTerm
-
parent
-
index
-
-
Constructor Details
-
FieldReader
FieldReader(Lucene40BlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, BytesRef rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, IndexInput metaIn, 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
-
getStats
For debugging -- used by CheckIndex too- Overrides:
getStats
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
-
intersect
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.
- Overrides:
intersect
in classTerms
- Throws:
IOException
-
toString
-