Module org.apache.lucene.suggest
Package org.apache.lucene.search.suggest
Class BufferedInputIterator
java.lang.Object
org.apache.lucene.search.suggest.BufferedInputIterator
- All Implemented Interfaces:
InputIterator
,BytesRefIterator
- Direct Known Subclasses:
UnsortedInputIterator
This wrapper buffers incoming elements.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.lucene.search.suggest.InputIterator
InputIterator.InputIteratorWrapper
-
Field Summary
FieldsModifier and TypeFieldDescriptionbuffered context set entriesprotected int
current buffer positionprotected BytesRefArray
buffered term entriesprotected long[]
buffered weights, parallel withentries
private final boolean
private final boolean
protected BytesRefArray
buffered payload entriesprivate final BytesRefBuilder
private final BytesRefBuilder
Fields inherited from interface org.apache.lucene.search.suggest.InputIterator
EMPTY
-
Constructor Summary
ConstructorsConstructorDescriptionBufferedInputIterator
(InputIterator source) Creates a new iterator, buffering entries from the specified iterator -
Method Summary
Modifier and TypeMethodDescriptioncontexts()
A term's contexts context can be used to filter suggestions.boolean
Returns true if the iterator has contextsboolean
Returns true if the iterator has payloadsnext()
Increments the iteration to the nextBytesRef
in the iterator.payload()
An arbitrary byte[] to record per suggestion.long
weight()
A term's weight, higher numbers mean better suggestions.
-
Field Details
-
entries
buffered term entries -
payloads
buffered payload entries -
contextSets
buffered context set entries -
curPos
protected int curPoscurrent buffer position -
freqs
protected long[] freqsbuffered weights, parallel withentries
-
spare
-
payloadSpare
-
hasPayloads
private final boolean hasPayloads -
hasContexts
private final boolean hasContexts
-
-
Constructor Details
-
BufferedInputIterator
Creates a new iterator, buffering entries from the specified iterator- Throws:
IOException
-
-
Method Details
-
weight
public long weight()Description copied from interface:InputIterator
A term's weight, higher numbers mean better suggestions.- Specified by:
weight
in interfaceInputIterator
-
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.- Specified by:
next
in interfaceBytesRefIterator
- Returns:
- the next
BytesRef
in the iterator ornull
if the end of the iterator is reached. - Throws:
IOException
- If there is a low-level I/O error.
-
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
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
-