Module org.apache.lucene.core
Package org.apache.lucene.index
Class FreqProxFields.FreqProxTermsEnum
java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.BaseTermsEnum
org.apache.lucene.index.FreqProxFields.FreqProxTermsEnum
- All Implemented Interfaces:
BytesRefIterator
- Enclosing class:
FreqProxFields
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
(package private) int
(package private) final FreqProxTermsWriterPerField.FreqProxPostingsArray
(package private) final BytesRef
(package private) final int[]
(package private) final FreqProxTermsWriterPerField
(package private) final BytesRefBlockPool
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
docFreq()
Returns the number of documents containing the current term.impacts
(int flags) Return aImpactsEnum
.next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.postings
(PostingsEnum reuse, int flags) GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.void
reset()
Seeks to the specified term, if it exists, or to the next (ceiling) term.void
seekExact
(long ord) Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord()
.term()
Returns current term.Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.long
Returns 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, prepareSeekExact, seekExact, seekExact
-
Field Details
-
terms
-
termsPool
-
sortedTermIDs
final int[] sortedTermIDs -
postingsArray
-
scratch
-
numTerms
final int numTerms -
ord
int ord
-
-
Constructor Details
-
FreqProxTermsEnum
FreqProxTermsEnum(FreqProxTermsWriterPerField terms)
-
-
Method Details
-
reset
public void reset() -
seekCeil
Description copied from class:TermsEnum
Seeks 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. -
seekExact
public void seekExact(long ord) Description copied from class:TermsEnum
Seeks 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. -
next
Description copied from interface:BytesRefIterator
Increments the iteration to the nextBytesRef
in the iterator. Returns the resultingBytesRef
ornull
if 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
BytesRef
in the iterator ornull
if the end of the iterator is reached.
-
term
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned. -
ord
public long ord()Description copied from class:TermsEnum
Returns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException
). Do not call this when the enum is unpositioned. -
docFreq
public int docFreq()Description copied from class:TermsEnum
Returns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END
. -
totalTermFreq
public long totalTermFreq()Description copied from class:TermsEnum
Returns 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:
totalTermFreq
in classTermsEnum
-
postings
Description copied from class:TermsEnum
GetPostingsEnum
for 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:
postings
in classTermsEnum
- Parameters:
reuse
- pass a prior PostingsEnum for possible reuseflags
- specifies which optional per-document values you require; seePostingsEnum.FREQS
-
impacts
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
IOException
- See Also:
-
termState
Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.NOTE: A seek by
TermState
might not capture theAttributeSource
's state. Callers must maintain theAttributeSource
states separately- Overrides:
termState
in classBaseTermsEnum
- Throws:
IOException
- See Also:
-