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

Class HunspellTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase.AbstractBuilder<HunspellTokenFilter.Builder>

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

All Implemented Interfaces:

WithJson<HunspellTokenFilter.Builder>, ObjectBuilder<HunspellTokenFilter>

Enclosing class:

HunspellTokenFilter

public static class HunspellTokenFilter.Builder
extends TokenFilterBase.AbstractBuilder<HunspellTokenFilter.Builder>
implements ObjectBuilder<HunspellTokenFilter>

Builder for HunspellTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HunspellTokenFilter	build()	Builds a HunspellTokenFilter.
final HunspellTokenFilter.Builder	dedup(Boolean value)	If true, duplicate tokens are removed from the filter’s output.
final HunspellTokenFilter.Builder	dictionary(String value)	One or more .dic files (e.g, en_US.dic, my_custom.dic) to use for the Hunspell dictionary.
final HunspellTokenFilter.Builder	locale(String value)	Required - Locale directory used to specify the .aff and .dic files for a Hunspell dictionary.
final HunspellTokenFilter.Builder	longestOnly(Boolean value)	If true, only the longest stemmed version of each token is included in the output.
protected HunspellTokenFilter.Builder	self()

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

version

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dedup

public final HunspellTokenFilter.Builder dedup(@Nullable
 Boolean value)

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

API name: dedup

dictionary

public final HunspellTokenFilter.Builder dictionary(@Nullable
 String value)

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 HunspellTokenFilter.Builder locale(String value)

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

API name: locale

longestOnly

public final HunspellTokenFilter.Builder longestOnly(@Nullable
 Boolean value)

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

self

protected HunspellTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<HunspellTokenFilter.Builder>

build

public HunspellTokenFilter build()

Builds a HunspellTokenFilter.

Specified by:

build in interface ObjectBuilder<HunspellTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.