Module org.apache.lucene.suggest
Package org.apache.lucene.search.spell
Class HighFrequencyDictionary.HighFrequencyIterator
- java.lang.Object
-
- org.apache.lucene.search.spell.HighFrequencyDictionary.HighFrequencyIterator
-
- All Implemented Interfaces:
InputIterator
,BytesRefIterator
- Enclosing class:
- HighFrequencyDictionary
final class HighFrequencyDictionary.HighFrequencyIterator extends java.lang.Object implements InputIterator
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.lucene.search.suggest.InputIterator
InputIterator.InputIteratorWrapper
-
-
Field Summary
Fields Modifier and Type Field Description private long
freq
private int
minNumDocs
private BytesRefBuilder
spare
private TermsEnum
termsEnum
-
Fields inherited from interface org.apache.lucene.search.suggest.InputIterator
EMPTY
-
-
Constructor Summary
Constructors Constructor Description HighFrequencyIterator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<BytesRef>
contexts()
A term's contexts context can be used to filter suggestions.boolean
hasContexts()
Returns true if the iterator has contextsboolean
hasPayloads()
Returns true if the iterator has payloadsprivate boolean
isFrequent(int freq)
BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.BytesRef
payload()
An arbitrary byte[] to record per suggestion.long
weight()
A term's weight, higher numbers mean better suggestions.
-
-
-
Field Detail
-
spare
private final BytesRefBuilder spare
-
termsEnum
private final TermsEnum termsEnum
-
minNumDocs
private int minNumDocs
-
freq
private long freq
-
-
Method Detail
-
isFrequent
private boolean isFrequent(int freq)
-
weight
public long weight()
Description copied from interface:InputIterator
A term's weight, higher numbers mean better suggestions.- Specified by:
weight
in interfaceInputIterator
-
next
public BytesRef next() throws java.io.IOException
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.- Specified by:
next
in interfaceBytesRefIterator
- Returns:
- the next
BytesRef
in the iterator ornull
if the end of the iterator is reached. - Throws:
java.io.IOException
- If there is a low-level I/O error.
-
payload
public BytesRef payload()
Description copied from interface:InputIterator
An arbitrary byte[] to record per suggestion. SeeLookup.LookupResult.payload
to retrieve the payload for each suggestion.- Specified by:
payload
in interfaceInputIterator
-
hasPayloads
public boolean hasPayloads()
Description copied from interface:InputIterator
Returns true if the iterator has payloads- Specified by:
hasPayloads
in interfaceInputIterator
-
contexts
public java.util.Set<BytesRef> contexts()
Description copied from interface:InputIterator
A term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context- Specified by:
contexts
in interfaceInputIterator
-
hasContexts
public boolean hasContexts()
Description copied from interface:InputIterator
Returns true if the iterator has contexts- Specified by:
hasContexts
in interfaceInputIterator
-
-