Package co.elastic.clients.elasticsearch._types.analysis

Class HunspellTokenFilter

java.lang.Object

co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

co.elastic.clients.elasticsearch._types.analysis.HunspellTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class HunspellTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HunspellTokenFilter.Builder	Builder for HunspellTokenFilter.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

TokenFilterBase.AbstractBuilder<BuilderT extends TokenFilterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<HunspellTokenFilter>	_DESERIALIZER	Json deserializer for HunspellTokenFilter

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final Boolean	dedup()	If true, duplicate tokens are removed from the filter’s output.
final String	dictionary()	One or more .dic files (e.g, en_US.dic, my_custom.dic) to use for the Hunspell dictionary.
final String	locale()	Required - Locale directory used to specify the .aff and .dic files for a Hunspell dictionary.
final Boolean	longestOnly()	If true, only the longest stemmed version of each token is included in the output.
static HunspellTokenFilter	of(Function<HunspellTokenFilter.Builder,ObjectBuilder<HunspellTokenFilter>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHunspellTokenFilterDeserializer(ObjectDeserializer<HunspellTokenFilter.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

serialize, setupTokenFilterBaseDeserializer, toString, version

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.JsonpSerializable

serialize

Methods inherited from interface co.elastic.clients.elasticsearch._types.analysis.TokenFilterDefinitionVariant

_toTokenFilterDefinition

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HunspellTokenFilter> _DESERIALIZER

Json deserializer for HunspellTokenFilter

Method Details

of

public static HunspellTokenFilter of(Function<HunspellTokenFilter.Builder,ObjectBuilder<HunspellTokenFilter>> fn)

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

dedup

@Nullable
public final Boolean dedup()

If true, duplicate tokens are removed from the filter’s output. Defaults to true.

API name: dedup

dictionary

@Nullable
public final String dictionary()

One or more .dic files (e.g, en_US.dic, my_custom.dic) to use for the Hunspell dictionary. By default, the hunspell filter uses all .dic files in the <$ES_PATH_CONF>/hunspell/<locale> directory specified using the lang, language, or locale parameter.

API name: dictionary

locale

public final String locale()

Required - Locale directory used to specify the .aff and .dic files for a Hunspell dictionary.

API name: locale

longestOnly

@Nullable
public final Boolean longestOnly()

If true, only the longest stemmed version of each token is included in the output. If false, all stemmed versions of the token are included. Defaults to false.

API name: longest_only

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class TokenFilterBase

setupHunspellTokenFilterDeserializer

protected static void setupHunspellTokenFilterDeserializer(ObjectDeserializer<HunspellTokenFilter.Builder> op)