Package com.apple.foundationdb.record.lucene

Class LuceneAutoCompleteAnalyzerFactory

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneAutoCompleteAnalyzerFactory

All Implemented Interfaces:

LuceneAnalyzerFactory

@AutoService(LuceneAnalyzerFactory.class)
public class LuceneAutoCompleteAnalyzerFactory
extends Object
implements LuceneAnalyzerFactory

Factory to build index and query Analyzer for auto-complete suggestions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYZER_FACTORY_NAME

Constructor Summary

Constructors

Constructor	Description
LuceneAutoCompleteAnalyzerFactory()

Method Summary

Modifier and Type	Method	Description
AnalyzerChooser	getIndexAnalyzerChooser(Index index)	Get an instance of AnalyzerChooser that chooses the Lucene analyzer based on texts for indexing, given the Index.
String	getName()	Get the unique name for the Lucene analyzer factory.
LuceneAnalyzerType	getType()	Get the LuceneAnalyzerType for the Lucene analyzer factory.

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.lucene.LuceneAnalyzerFactory

getQueryAnalyzerChooser

Field Details

ANALYZER_FACTORY_NAME

public static final String ANALYZER_FACTORY_NAME

See Also:

• Constant Field Values

Constructor Details

LuceneAutoCompleteAnalyzerFactory

public LuceneAutoCompleteAnalyzerFactory()

Method Details

getName

@Nonnull
public String getName()

Description copied from interface: LuceneAnalyzerFactory

Get the unique name for the Lucene analyzer factory. This is the name that should be included in the index meta-data in order to indicate that this analyzer factory should be used within a certain index.

Specified by:

getName in interface LuceneAnalyzerFactory

Returns:

the name of the analyzer that this factory creates

getType

@Nonnull
public LuceneAnalyzerType getType()

Description copied from interface: LuceneAnalyzerFactory

Get the LuceneAnalyzerType for the Lucene analyzer factory.

Specified by:

getType in interface LuceneAnalyzerFactory

Returns:

the LuceneScanTypes used to determine how the analyzers build by this factory is used

getIndexAnalyzerChooser

@Nonnull
public AnalyzerChooser getIndexAnalyzerChooser(@Nonnull
 Index index)

Description copied from interface: LuceneAnalyzerFactory

Get an instance of AnalyzerChooser that chooses the Lucene analyzer based on texts for indexing, given the Index. For a given factory, each indexing analyzer chosen should be of the same type, and it should match the result of LuceneAnalyzerFactory.getName().

Specified by:

getIndexAnalyzerChooser in interface LuceneAnalyzerFactory

Parameters:

index - the index thi analyzer is used for

Returns:

an instance of the AnalyzerChooser for indexing that this factory creates