Package org.apache.lucene.search.suggest
Class DocumentDictionary.DocumentInputIterator
- java.lang.Object
-
- org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
-
- All Implemented Interfaces:
InputIterator
,BytesRefIterator
- Enclosing class:
- DocumentDictionary
protected class DocumentDictionary.DocumentInputIterator extends Object implements InputIterator
ImplementsInputIterator
from stored fields.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.lucene.search.suggest.InputIterator
InputIterator.InputIteratorWrapper
-
-
Field Summary
-
Fields inherited from interface org.apache.lucene.search.suggest.InputIterator
EMPTY
-
-
Constructor Summary
Constructors Constructor Description DocumentInputIterator(boolean hasPayloads, boolean hasContexts)
Creates an iterator over term, weight and payload fields from the lucene index.
-
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.protected long
getWeight(Document doc, int docId)
Returns the value of theweightField
for the current document.boolean
hasContexts()
Returns true if the iterator has contextsboolean
hasPayloads()
Returns true if the iterator has payloadsBytesRef
next()
BytesRef
payload()
An arbitrary byte[] to record per suggestion.long
weight()
A term's weight, higher numbers mean better suggestions.
-
-
-
Constructor Detail
-
DocumentInputIterator
public DocumentInputIterator(boolean hasPayloads, boolean hasContexts) throws IOException
Creates an iterator over term, weight and payload fields from the lucene index. settingwithPayload
to false, implies an iterator over only term and weight.- Throws:
IOException
-
-
Method Detail
-
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 IOException
- Specified by:
next
in interfaceBytesRefIterator
- Throws:
IOException
-
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
-
getWeight
protected long getWeight(Document doc, int docId) throws IOException
Returns the value of theweightField
for the current document. Retrieves the value for theweightField
if it's stored (usingdoc
) or if it's indexed asNumericDocValues
(usingdocId
) for the document. If no value is found, then the weight is 0.- Throws:
IOException
-
contexts
public 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
-
-