Package org.apache.lucene.search.suggest
Class UnsortedInputIterator
- java.lang.Object
-
- org.apache.lucene.search.suggest.BufferedInputIterator
-
- org.apache.lucene.search.suggest.UnsortedInputIterator
-
- All Implemented Interfaces:
InputIterator,BytesRefIterator
public class UnsortedInputIterator extends BufferedInputIterator
This wrapper buffers the incoming elements and makes sure they are in random order.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.lucene.search.suggest.InputIterator
InputIterator.InputIteratorWrapper
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.suggest.BufferedInputIterator
contextSets, curPos, entries, freqs, payloads
-
Fields inherited from interface org.apache.lucene.search.suggest.InputIterator
EMPTY
-
-
Constructor Summary
Constructors Constructor Description UnsortedInputIterator(InputIterator source)Creates a new iterator, wrapping the specified iterator and returning elements in a random order.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<BytesRef>contexts()A term's contexts context can be used to filter suggestions.BytesRefnext()BytesRefpayload()An arbitrary byte[] to record per suggestion.longweight()A term's weight, higher numbers mean better suggestions.-
Methods inherited from class org.apache.lucene.search.suggest.BufferedInputIterator
hasContexts, hasPayloads
-
-
-
-
Constructor Detail
-
UnsortedInputIterator
public UnsortedInputIterator(InputIterator source) throws IOException
Creates a new iterator, wrapping the specified iterator and returning elements in a random order.- Throws:
IOException
-
-
Method Detail
-
weight
public long weight()
Description copied from interface:InputIteratorA term's weight, higher numbers mean better suggestions.- Specified by:
weightin interfaceInputIterator- Overrides:
weightin classBufferedInputIterator
-
next
public BytesRef next() throws IOException
- Specified by:
nextin interfaceBytesRefIterator- Overrides:
nextin classBufferedInputIterator- Throws:
IOException
-
payload
public BytesRef payload()
Description copied from interface:InputIteratorAn arbitrary byte[] to record per suggestion. SeeLookup.LookupResult.payloadto retrieve the payload for each suggestion.- Specified by:
payloadin interfaceInputIterator- Overrides:
payloadin classBufferedInputIterator
-
contexts
public Set<BytesRef> contexts()
Description copied from interface:InputIteratorA term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context- Specified by:
contextsin interfaceInputIterator- Overrides:
contextsin classBufferedInputIterator
-
-