elastic4s-domain
API
Generated with
elastic4s-domain/com.sksamuel.elastic4s/com.sksamuel.elastic4s.analysis

com.sksamuel.elastic4s.analysis

package com.sksamuel.elastic4s.analysis

Members list

Type members

Classlikes

case class Analysis(analyzers: List[Analyzer], tokenizers: List[Tokenizer], tokenFilters: List[TokenFilter], charFilters: List[CharFilter], normalizers: List[Normalizer])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Analysis

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Analysis.type
object AnalysisBuilder extends Builder[Analysis]

Attributes

Supertypes
trait Builder[Analysis]
class Object
trait Matchable
class Any
Self type
trait Analyzer

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class StopAnalyzer
trait Builder[T]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AnalysisBuilder.type
object CustomAnalyzerBuilder.type
object NormalizerBuilder.type
trait CharFilter

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class CharGroupTokenizer(name: String, tokenizeOnChars: List[String]) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class ClassicTokenizer(name: String, maxTokenLength: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class CommonGramsTokenFilter(name: String, commonWords: Iterable[String], commonWordsPath: Option[String], ignoreCase: Option[Boolean], queryMode: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class CompoundWordTokenFilter(name: String, `type`: CompoundWordTokenFilterType, wordList: Iterable[String], wordListPath: Option[String], hyphenationPatternsPath: Option[String], minWordSize: Option[Int], minSubwordSize: Option[Int], maxSubwordSize: Option[Int], onlyLongestMatch: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
sealed trait CompoundWordTokenFilterType

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class CustomAnalyzer(name: String, tokenizer: String, charFilters: List[String], tokenFilters: List[String], positionIncrementGap: Int) extends Analyzer

When the built-in analyzers do not fulfil your needs, you can create a custom analyzer which uses the appropriate combination of:

When the built-in analyzers do not fulfil your needs, you can create a custom analyzer which uses the appropriate combination of:

zero or more character filters a tokenizer zero or more token filters.

Reference these by name, and if they are custom or configurable add them to the analysis definition.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Analyzer
class Object
trait Matchable
class Any
Show all
object CustomAnalyzerBuilder extends Builder[CustomAnalyzer]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class CustomNormalizer(name: String, charFilters: List[String], tokenFilters: List[String]) extends Normalizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Normalizer
class Object
trait Matchable
class Any
Show all
case object DictionaryDecompounder extends CompoundWordTokenFilterType

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class EdgeNGramTokenFilter(name: String, minGram: Int, maxGram: Int, side: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class EdgeNGramTokenizer(name: String, minGram: Int, maxGram: Int, tokenChars: Iterable[String]) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class ElisionTokenFilter(name: String, articles: Seq[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class FingerprintAnalyzer(name: String, separator: Option[String], stopwords: Iterable[String], maxOutputSize: Int) extends Analyzer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Analyzer
class Object
trait Matchable
class Any
Show all
case class HunspellTokenFilter(name: String, locale: String, dedup: Option[Boolean], longestOnly: Option[Boolean], dictionary: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case object HyphenationDecompounder extends CompoundWordTokenFilterType

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class ICUTokenizer(name: String, ruleFiles: String) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class KeywordMarkerTokenFilter(name: String, keywords: Seq[String], keywordsPath: Option[String], keywordsPattern: Option[String], ignoreCase: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class KeywordTokenizer(name: String, bufferSize: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
object LanguageAnalyzers

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class LengthTokenFilter(name: String, min: Option[Int], max: Option[Int]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class LimitTokenCountTokenFilter(name: String, maxTokenCount: Option[Int], consumeAllTokens: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class MappingCharFilter(name: String, mappings: Map[String, String]) extends CharFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait CharFilter
class Object
trait Matchable
class Any
Show all
case class MultiplexerTokenFilter(name: String, filters: Seq[String], preserveOriginal: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class NGramTokenFilter(name: String, minGram: Option[Int], maxGram: Option[Int]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class NGramTokenizer(name: String, minGram: Int, maxGram: Int, tokenChars: Iterable[String]) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
object NamedStopTokenFilter

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait Normalizer

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NormalizerBuilder extends Builder[CustomNormalizer]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class PathHierarchyTokenizer(name: String, delimiter: Char, replacement: Char, bufferSize: Int, reverse: Boolean, skip: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class PatternAnalyzer(name: String, regex: String, lowercase: Boolean) extends Analyzer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Analyzer
class Object
trait Matchable
class Any
Show all
case class PatternCaptureTokenFilter(name: String, patterns: Seq[String], preserveOriginal: Boolean) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class PatternReplaceCharFilter(name: String, pattern: String, replacement: String) extends CharFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait CharFilter
class Object
trait Matchable
class Any
Show all
case class PatternReplaceTokenFilter(name: String, pattern: String, replacement: String) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class PatternTokenizer(name: String, pattern: String, flags: String, group: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class ShingleTokenFilter(name: String, maxShingleSize: Option[Int], minShingleSize: Option[Int], outputUnigrams: Option[Boolean], outputUnigramsIfNoShingles: Option[Boolean], tokenSeparator: Option[String], fillerToken: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class SnowballTokenFilter(name: String, language: String) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class StandardAnalyzer(name: String, stopwords: Iterable[String], maxTokenLength: Int) extends Analyzer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Analyzer
class Object
trait Matchable
class Any
Show all
case class StandardTokenizer(name: String, maxTokenLength: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class StemmerOverrideTokenFilter(name: String, rules: Seq[String], rulesPath: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class StemmerTokenFilter(name: String, lang: String) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class StopAnalyzer(name: String, stopwords: Iterable[String]) extends Analyzer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Analyzer
class Object
trait Matchable
class Any
Show all
case class StopTokenFilter(name: String, language: Option[String], stopwords: Iterable[String], stopwordsPath: Option[String], enablePositionIncrements: Option[Boolean], removeTrailing: Option[Boolean], ignoreCase: Option[Boolean]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class SynonymGraphTokenFilter(name: String, path: Option[String], synonyms: Set[String], ignoreCase: Option[Boolean], format: Option[String], expand: Option[Boolean], tokenizer: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class SynonymTokenFilter(name: String, path: Option[String], synonyms: Set[String], ignoreCase: Option[Boolean], format: Option[String], expand: Option[Boolean], tokenizer: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class ThaiTokenizer(name: String) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
trait TokenFilter
trait Tokenizer

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ICUTokenizer
Show all
case class TruncateTokenFilter(name: String, length: Int) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class UaxUrlEmailTokenizer(name: String, maxTokenLength: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class UniqueTokenFilter(name: String, onlyOnSamePosition: Boolean) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class WhitespaceTokenizer(name: String, maxTokenLength: Int) extends Tokenizer

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Tokenizer
class Object
trait Matchable
class Any
Show all
case class WordDelimiterGraphTokenFilter(name: String, preserveOriginal: Option[Boolean], catenateNumbers: Option[Boolean], catenateWords: Option[Boolean], catenateAll: Option[Boolean], generateWordParts: Option[Boolean], generateNumberParts: Option[Boolean], protectedWords: Option[String], protectedWordsPath: Option[String], splitOnCaseChange: Option[Boolean], splitOnNumerics: Option[Boolean], stem_english_possessive: Option[Boolean], typeTable: Option[String], typeTablePath: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
case class WordDelimiterTokenFilter(name: String, generateWordParts: Option[Boolean], generateNumberParts: Option[Boolean], catenateWords: Option[Boolean], catenateNumbers: Option[Boolean], catenateAll: Option[Boolean], splitOnCaseChange: Option[Boolean], protectedWords: Option[String], protectedWordsPath: Option[String], preserveOriginal: Option[Boolean], splitOnNumerics: Option[Boolean], stemEnglishPossesive: Option[Boolean], typeTable: Option[String], typeTablePath: Option[String]) extends TokenFilter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TokenFilter
class Object
trait Matchable
class Any
Show all
Generated with