common/org.gnit.lucenekmp.analysis.custom/CustomAnalyzer/Builder/when

when

fun when(name: String, vararg params: String): CustomAnalyzer.ConditionBuilder

Add a ConditionalTokenFilterFactory to the analysis chain

TokenFilters added by subsequent calls to [ConditionBuilder.addTokenFilter] and related functions will only be used if the current token matches the condition. Consumers must call [ConditionBuilder.endwhen] to return to the normal tokenfilter chain once conditional filters have been added

Parameters

name

is used to look up the factory with TokenFilterFactory.forName

params

the parameters to be passed to the factory

fun when(name: String, params: MutableMap<String, String>): CustomAnalyzer.ConditionBuilder

Add a ConditionalTokenFilterFactory to the analysis chain

TokenFilters added by subsequent calls to [ConditionBuilder.addTokenFilter] and related functions will only be used if the current token matches the condition. Consumers must call [ConditionBuilder.endwhen] to return to the normal tokenfilter chain once conditional filters have been added

Parameters

name

is used to look up the factory with TokenFilterFactory.forName

params

the parameters to be passed to the factory. The map must be modifiable

fun when(factory: KClass<out ConditionalTokenFilterFactory>, vararg params: String): CustomAnalyzer.ConditionBuilder

Add a ConditionalTokenFilterFactory to the analysis chain

TokenFilters added by subsequent calls to [ConditionBuilder.addTokenFilter] and related functions will only be used if the current token matches the condition. Consumers must call [ConditionBuilder.endwhen] to return to the normal tokenfilter chain once conditional filters have been added

Parameters

factory

class that is used to create the ConditionalTokenFilter

params

the parameters to be passed to the factory

fun when(factory: KClass<out ConditionalTokenFilterFactory>, params: MutableMap<String, String>): CustomAnalyzer.ConditionBuilder

Add a ConditionalTokenFilterFactory to the analysis chain

TokenFilters added by subsequent calls to [ConditionBuilder.addTokenFilter] and related functions will only be used if the current token matches the condition. Consumers must call [ConditionBuilder.endwhen] to return to the normal tokenfilter chain once conditional filters have been added

Parameters

factory

class that is used to create the ConditionalTokenFilter

params

the parameters to be passed to the factory. The map must be modifiable

fun when(factory: ConditionalTokenFilterFactory): CustomAnalyzer.ConditionBuilder

Add a ConditionalTokenFilterFactory to the analysis chain

TokenFilters added by subsequent calls to [ConditionBuilder.addTokenFilter] and related functions will only be used if the current token matches the condition. Consumers must call [ConditionBuilder.endwhen] to return to the normal tokenfilter chain once conditional filters have been added