Package com.apple.foundationdb.record.lucene

Class LuceneSpellCheckRecordCursor

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneSpellCheckRecordCursor

All Implemented Interfaces:

BaseCursor<IndexEntry>, RecordCursor<IndexEntry>, AutoCloseable

public class LuceneSpellCheckRecordCursor
extends Object
implements BaseCursor<IndexEntry>

Cursor over Lucene spell-check query results.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.RecordCursor

RecordCursor.ContinuationConvertor, RecordCursor.NoNextReason

Constructor Summary

Constructors

Constructor	Description
LuceneSpellCheckRecordCursor(List<String> fields, String wordToSpellCheck, Executor executor, ScanProperties scanProperties, IndexMaintainerState state, Tuple groupingKey, Integer partitionId)

Method Summary

Modifier and Type	Method	Description
boolean	accept(RecordCursorVisitor visitor)
void	close()
Executor	getExecutor()
boolean	isClosed()
CompletableFuture<RecordCursorResult<IndexEntry>>	onNext()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.RecordCursor

asIterator, asList, asList, asStream, asStream, filter, filterAsync, filterAsyncInstrumented, filterAsyncInstrumented, filterInstrumented, filterInstrumented, first, forEach, forEachAsync, forEachResult, forEachResultAsync, getCount, getNext, limitRowsTo, map, mapEffect, mapEffect, mapPipelined, mapResult, reduce, reduce, skip, skipThenLimit

Constructor Details

LuceneSpellCheckRecordCursor

public LuceneSpellCheckRecordCursor(@Nonnull
 List<String> fields,
 @Nonnull
 String wordToSpellCheck,
 @Nonnull
 Executor executor,
 ScanProperties scanProperties,
 @Nonnull
 IndexMaintainerState state,
 @Nullable
 Tuple groupingKey,
 @Nullable
 Integer partitionId)

Method Details

onNext

@Nonnull
public CompletableFuture<RecordCursorResult<IndexEntry>> onNext()

Specified by:

onNext in interface RecordCursor<IndexEntry>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RecordCursor<IndexEntry>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface RecordCursor<IndexEntry>

getExecutor

@Nonnull
public Executor getExecutor()

Specified by:

getExecutor in interface RecordCursor<IndexEntry>

accept

public boolean accept(@Nonnull
 RecordCursorVisitor visitor)

Specified by:

accept in interface RecordCursor<IndexEntry>