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
private static class FreqProxFields.FreqProxTermsEnum extends BaseTermsEnum
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
numTerms
(package private) int
ord
(package private) FreqProxTermsWriterPerField.FreqProxPostingsArray
postingsArray
(package private) BytesRef
scratch
(package private) int[]
sortedTermIDs
(package private) FreqProxTermsWriterPerField
terms
-
Constructor Summary
Constructors Constructor Description FreqProxTermsEnum(FreqProxTermsWriterPerField terms)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
docFreq()
Returns the number of documents containing the current term.ImpactsEnum
impacts(int flags)
Return aImpactsEnum
.BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.PostingsEnum
postings(PostingsEnum reuse, int flags)
GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.void
reset()
TermsEnum.SeekStatus
seekCeil(BytesRef text)
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()
.BytesRef
term()
Returns current term.TermState
termState()
Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.long
totalTermFreq()
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, seekExact, seekExact
-
-
-
-
Field Detail
-
terms
final FreqProxTermsWriterPerField terms
-
sortedTermIDs
final int[] sortedTermIDs
-
postingsArray
final FreqProxTermsWriterPerField.FreqProxPostingsArray postingsArray
-
scratch
final BytesRef scratch
-
numTerms
final int numTerms
-
ord
int ord
-
-
Constructor Detail
-
FreqProxTermsEnum
FreqProxTermsEnum(FreqProxTermsWriterPerField terms)
-
-
Method Detail
-
reset
public void reset()
-
seekCeil
public TermsEnum.SeekStatus seekCeil(BytesRef text)
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
public BytesRef 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
public BytesRef 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
public PostingsEnum postings(PostingsEnum reuse, int flags)
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
public ImpactsEnum impacts(int flags) throws java.io.IOException
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
java.io.IOException
- See Also:
TermsEnum.postings(PostingsEnum, int)
-
termState
public TermState termState() throws java.io.IOException
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:
java.io.IOException
- See Also:
TermState
,BaseTermsEnum.seekExact(BytesRef, TermState)
-
-