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

Class WordDelimiterTokenFilterBase

java.lang.Object
co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase
co.elastic.clients.elasticsearch._types.analysis.WordDelimiterTokenFilterBase
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
WordDelimiterGraphTokenFilter, WordDelimiterTokenFilter
public abstract class WordDelimiterTokenFilterBase extends TokenFilterBase
See Also:

  • Constructor Details

  • Method Details

    • catenateAll

      @Nullable public final Boolean catenateAll()
      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

      @Nullable public final Boolean catenateNumbers()
      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

      @Nullable public final Boolean catenateWords()
      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

      @Nullable public final Boolean generateNumberParts()
      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

      @Nullable public final Boolean generateWordParts()
      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

      @Nullable public final Boolean preserveOriginal()
      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 List<String> protectedWords()
      Array of tokens the filter won’t split.

      API name: protected_words

    • protectedWordsPath

      @Nullable public final String protectedWordsPath()
      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

      @Nullable public final Boolean splitOnCaseChange()
      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

      @Nullable public final Boolean splitOnNumerics()
      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

      @Nullable public final Boolean stemEnglishPossessive()
      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 List<String> typeTable()
      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

    • typeTablePath

      @Nullable public final String typeTablePath()
      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

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class TokenFilterBase

    • setupWordDelimiterTokenFilterBaseDeserializer

      protected static <BuilderT extends WordDelimiterTokenFilterBase.AbstractBuilder<BuilderT>> void setupWordDelimiterTokenFilterBaseDeserializer(ObjectDeserializer<BuilderT> op)