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

Class WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT extends WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.analysis.WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
WordDelimiterGraphTokenFilter.Builder, WordDelimiterTokenFilter.Builder
Enclosing class:
WordDelimiterTokenFilterBase
public abstract static class WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT extends WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT>> extends TokenFilterBase.AbstractBuilder<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • catenateAll

      public final BuilderT catenateAll(@Nullable Boolean value)
      If true, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to false.

      API name: catenate_all

    • catenateNumbers

      public final BuilderT catenateNumbers(@Nullable Boolean value)
      If true, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to false.

      API name: catenate_numbers

    • catenateWords

      public final BuilderT catenateWords(@Nullable Boolean value)
      If true, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to false.

      API name: catenate_words

    • generateNumberParts

      public final BuilderT generateNumberParts(@Nullable Boolean value)
      If true, the filter includes tokens consisting of only numeric characters in the output. If false, the filter excludes these tokens from the output. Defaults to true.

      API name: generate_number_parts

    • generateWordParts

      public final BuilderT generateWordParts(@Nullable Boolean value)
      If true, the filter includes tokens consisting of only alphabetical characters in the output. If false, the filter excludes these tokens from the output. Defaults to true.

      API name: generate_word_parts

    • preserveOriginal

      public final BuilderT preserveOriginal(@Nullable Boolean value)
      If true, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to false.

      API name: preserve_original

    • protectedWords

      public final BuilderT protectedWords(List<String> list)
      Array of tokens the filter won’t split.

      API name: protected_words

      Adds all elements of list to protectedWords.

    • protectedWords

      public final BuilderT protectedWords(String value, String... values)
      Array of tokens the filter won’t split.

      API name: protected_words

      Adds one or more values to protectedWords.

    • protectedWordsPath

      public final BuilderT protectedWordsPath(@Nullable String value)
      Path to a file that contains a list of tokens the filter won’t split. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.

      API name: protected_words_path

    • splitOnCaseChange

      public final BuilderT splitOnCaseChange(@Nullable Boolean value)
      If true, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to true.

      API name: split_on_case_change

    • splitOnNumerics

      public final BuilderT splitOnNumerics(@Nullable Boolean value)
      If true, the filter splits tokens at letter-number transitions. For example: j2se -> [ j, 2, se ]. Defaults to true.

      API name: split_on_numerics

    • stemEnglishPossessive

      public final BuilderT stemEnglishPossessive(@Nullable Boolean value)
      If true, the filter removes the English possessive ('s) from the end of each token. For example: O'Neil's -> [ O, Neil ]. Defaults to true.

      API name: stem_english_possessive

    • typeTable

      public final BuilderT typeTable(List<String> list)
      Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.

      API name: type_table

      Adds all elements of list to typeTable.

    • typeTable

      public final BuilderT typeTable(String value, String... values)
      Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.

      API name: type_table

      Adds one or more values to typeTable.

    • typeTablePath

      public final BuilderT typeTablePath(@Nullable String value)
      Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.

      API name: type_table_path