Module org.apache.lucene.suggest
Package org.apache.lucene.search.suggest
Class InputIterator.InputIteratorWrapper
java.lang.Object
org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
- All Implemented Interfaces:
InputIterator
,BytesRefIterator
- Enclosing interface:
- InputIterator
Wraps a BytesRefIterator as a suggester InputIterator, with all weights set to
1
and carries no payload-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.lucene.search.suggest.InputIterator
InputIterator.InputIteratorWrapper
-
Field Summary
FieldsFields inherited from interface org.apache.lucene.search.suggest.InputIterator
EMPTY
-
Constructor Summary
ConstructorsConstructorDescriptionInputIteratorWrapper
(BytesRefIterator wrapped) Creates a new wrapper, wrapping the specified iterator and specifying a weight value of1
for all terms and nullifies associated payloads. -
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
-
wrapped
-
-
Constructor Details
-
InputIteratorWrapper
Creates a new wrapper, wrapping the specified iterator and specifying a weight value of1
for all terms and nullifies associated payloads.
-
-
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
-