Package com.apple.foundationdb.record.lucene.synonym

Class SynonymAnalyzer.AuthoritativeSynonymOnlyAnalyzerFactory

java.lang.Object

com.apple.foundationdb.record.lucene.synonym.SynonymAnalyzer.AuthoritativeSynonymOnlyAnalyzerFactory

All Implemented Interfaces:

LuceneAnalyzerFactory

Enclosing class:

SynonymAnalyzer

@AutoService(LuceneAnalyzerFactory.class)
public static class SynonymAnalyzer.AuthoritativeSynonymOnlyAnalyzerFactory
extends Object
implements LuceneAnalyzerFactory

An analyzer factory including synonym tokenizing on both index time and query time. Only authoritative phrase for each synonym group is included in the token stream.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYZER_FACTORY_NAME

Constructor Summary

Constructors

Constructor	Description
AuthoritativeSynonymOnlyAnalyzerFactory()

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.
AnalyzerChooser	getQueryAnalyzerChooser(Index index, AnalyzerChooser indexAnalyzerChooser)	Get an instance of AnalyzerChooser that chooses the Lucene analyzer for query given the Index.
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

Field Details

ANALYZER_FACTORY_NAME

public static final String ANALYZER_FACTORY_NAME

See Also:

• Constant Field Values

Constructor Details

AuthoritativeSynonymOnlyAnalyzerFactory

public AuthoritativeSynonymOnlyAnalyzerFactory()

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

getQueryAnalyzerChooser

@Nonnull
public AnalyzerChooser getQueryAnalyzerChooser(@Nonnull
 Index index,
 @Nonnull
 AnalyzerChooser indexAnalyzerChooser)

Description copied from interface: LuceneAnalyzerFactory

Get an instance of AnalyzerChooser that chooses the Lucene analyzer for query given the Index. For a given factory, each query analyzer chosen should be of the same type, and it should match the result of LuceneAnalyzerFactory.getName(). Call LuceneAnalyzerFactory.getIndexAnalyzerChooser(Index) before calling this method, and use its return for the argument indexAnalyzerChooser. No need to override this method if StandardAnalyzer is to be used for query time. Override this method to customize the analyzer for query time, or directly return the indexAnalyzerChooser instance, if it is used for both indexing and query time.

Specified by:

getQueryAnalyzerChooser in interface LuceneAnalyzerFactory

Parameters:

index - the index the analyzer is used for

indexAnalyzerChooser - indexAnalyzerChooser the instance of AnalyzerChooser for indexing used by this factory, that can be returned by this method in case it is also used for query

Returns:

an instance of the AnalyzerChooser for query that this factory creates, the default one is always using StandardAnalyzer