Module org.apache.lucene.core
Class Lucene90CompressingTermVectorsReader.TVTermsEnum
java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.BaseTermsEnum
org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingTermVectorsReader.TVTermsEnum
- All Implemented Interfaces:
BytesRefIterator
- Enclosing class:
Lucene90CompressingTermVectorsReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ByteArrayDataInputprivate int[]private intprivate intprivate int[]private BytesRefprivate int[]private int[]private int[]private int[]private intprivate int[]private final BytesRefprivate int[] -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintdocFreq()Returns the number of documents containing the current term.impacts(int flags) Return aImpactsEnum.next()Increments the iteration to the nextBytesRefin the iterator.longord()Returns ordinal position for current term.final PostingsEnumpostings(PostingsEnum reuse, int flags) GetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required.(package private) voidreset()(package private) voidreset(int numTerms, int flags, int[] prefixLengths, int[] suffixLengths, int[] termFreqs, int[] positionIndex, int[] positions, int[] startOffsets, int[] lengths, int[] payloadIndex, BytesRef payloads, ByteArrayDataInput in) Seeks to the specified term, if it exists, or to the next (ceiling) term.voidseekExact(long ord) Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord().term()Returns current term.longReturns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes, seekExact, seekExact, termState
-
Field Details
-
numTerms
private int numTerms -
startPos
private int startPos -
ord
private int ord -
prefixLengths
private int[] prefixLengths -
suffixLengths
private int[] suffixLengths -
termFreqs
private int[] termFreqs -
positionIndex
private int[] positionIndex -
positions
private int[] positions -
startOffsets
private int[] startOffsets -
lengths
private int[] lengths -
payloadIndex
private int[] payloadIndex -
in
-
payloads
-
term
-
-
Constructor Details
-
TVTermsEnum
private TVTermsEnum()
-
-
Method Details
-
reset
void reset(int numTerms, int flags, int[] prefixLengths, int[] suffixLengths, int[] termFreqs, int[] positionIndex, int[] positions, int[] startOffsets, int[] lengths, int[] payloadIndex, BytesRef payloads, ByteArrayDataInput in) -
reset
void reset() -
next
Description copied from interface:BytesRefIteratorIncrements the iteration to the nextBytesRefin the iterator. Returns the resultingBytesRefornullif the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.- Returns:
- the next
BytesRefin the iterator ornullif the end of the iterator is reached. - Throws:
IOException- If there is a low-level I/O error.
-
seekCeil
Description copied from class:TermsEnumSeeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.- Specified by:
seekCeilin classTermsEnum- Throws:
IOException
-
seekExact
Description copied from class:TermsEnumSeeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.- Specified by:
seekExactin classTermsEnum- Throws:
IOException
-
term
Description copied from class:TermsEnumReturns current term. Do not call this when the enum is unpositioned.- Specified by:
termin classTermsEnum- Throws:
IOException
-
ord
Description copied from class:TermsEnumReturns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException). Do not call this when the enum is unpositioned.- Specified by:
ordin classTermsEnum- Throws:
IOException
-
docFreq
Description copied from class:TermsEnumReturns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END.- Specified by:
docFreqin classTermsEnum- Throws:
IOException
-
totalTermFreq
Description copied from class:TermsEnumReturns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.- Specified by:
totalTermFreqin classTermsEnum- Throws:
IOException
-
postings
Description copied from class:TermsEnumGetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method will not return null.NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the
PostingsEnum.- Specified by:
postingsin classTermsEnum- Parameters:
reuse- pass a prior PostingsEnum for possible reuseflags- specifies which optional per-document values you require; seePostingsEnum.FREQS- Throws:
IOException
-
impacts
Description copied from class:TermsEnumReturn aImpactsEnum.- Specified by:
impactsin classTermsEnum- Throws:
IOException- See Also:
-