package analysis
Ordering
- Alphabetic
Visibility
- Public
- Protected
Type Members
- case class Analysis(analyzers: List[Analyzer], tokenizers: List[Tokenizer] = Nil, tokenFilters: List[TokenFilter] = Nil, charFilters: List[CharFilter] = Nil, normalizers: List[Normalizer] = Nil) extends Product with Serializable
- trait Analyzer extends AnyRef
- trait Builder[T] extends AnyRef
- trait CharFilter extends AnyRef
- case class CharGroupTokenizer(name: String, tokenizeOnChars: List[String]) extends Tokenizer with Product with Serializable
- case class ClassicTokenizer(name: String, maxTokenLength: Int) extends Tokenizer with Product with Serializable
- case class CommonGramsTokenFilter(name: String, commonWords: Iterable[String] = Nil, commonWordsPath: Option[String] = None, ignoreCase: Option[Boolean] = None, queryMode: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class CompoundWordTokenFilter(name: String, type: CompoundWordTokenFilterType, wordList: Iterable[String] = Nil, wordListPath: Option[String] = None, hyphenationPatternsPath: Option[String] = None, minWordSize: Option[Int] = None, minSubwordSize: Option[Int] = None, maxSubwordSize: Option[Int] = None, onlyLongestMatch: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- sealed trait CompoundWordTokenFilterType extends AnyRef
- case class CustomAnalyzer(name: String, tokenizer: String, charFilters: List[String] = Nil, tokenFilters: List[String] = Nil, positionIncrementGap: Int = 100) extends Analyzer with Product with Serializable
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.
- case class CustomNormalizer(name: String, charFilters: List[String], tokenFilters: List[String]) extends Normalizer with Product with Serializable
- case class EdgeNGramTokenFilter(name: String, minGram: Int, maxGram: Int, side: Option[String] = None) extends TokenFilter with Product with Serializable
- case class EdgeNGramTokenizer(name: String, minGram: Int = 1, maxGram: Int = 2, tokenChars: Iterable[String] = Nil) extends Tokenizer with Product with Serializable
- case class ElisionTokenFilter(name: String, articles: Seq[String] = Nil) extends TokenFilter with Product with Serializable
- case class FingerprintAnalyzer(name: String, separator: Option[String] = None, stopwords: Iterable[String] = Nil, maxOutputSize: Int = 255) extends Analyzer with Product with Serializable
- case class HunspellTokenFilter(name: String, locale: String, dedup: Option[Boolean] = None, longestOnly: Option[Boolean] = None, dictionary: Option[String] = None) extends TokenFilter with Product with Serializable
- case class ICUTokenizer(name: String, ruleFiles: String) extends Tokenizer with Product with Serializable
- case class KeywordMarkerTokenFilter(name: String, keywords: Seq[String] = Nil, keywordsPath: Option[String] = None, keywordsPattern: Option[String] = None, ignoreCase: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class KeywordTokenizer(name: String, bufferSize: Int = 256) extends Tokenizer with Product with Serializable
- case class LengthTokenFilter(name: String, min: Option[Int] = None, max: Option[Int] = None) extends TokenFilter with Product with Serializable
- case class LimitTokenCountTokenFilter(name: String, maxTokenCount: Option[Int] = None, consumeAllTokens: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class MappingCharFilter(name: String, mappings: Map[String, String]) extends CharFilter with Product with Serializable
- case class MultiplexerTokenFilter(name: String, filters: Seq[String] = Nil, preserveOriginal: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class NGramTokenFilter(name: String, minGram: Option[Int] = None, maxGram: Option[Int] = None) extends TokenFilter with Product with Serializable
- case class NGramTokenizer(name: String, minGram: Int = 1, maxGram: Int = 2, tokenChars: Iterable[String] = Nil) extends Tokenizer with Product with Serializable
- trait Normalizer extends AnyRef
- case class PathHierarchyTokenizer(name: String, delimiter: Char = '/', replacement: Char = '/', bufferSize: Int = 1024, reverse: Boolean = false, skip: Int = 0) extends Tokenizer with Product with Serializable
- case class PatternAnalyzer(name: String, regex: String, lowercase: Boolean = true) extends Analyzer with Product with Serializable
- case class PatternCaptureTokenFilter(name: String, patterns: Seq[String] = Nil, preserveOriginal: Boolean = true) extends TokenFilter with Product with Serializable
- case class PatternReplaceCharFilter(name: String, pattern: String, replacement: String) extends CharFilter with Product with Serializable
- case class PatternReplaceTokenFilter(name: String, pattern: String, replacement: String) extends TokenFilter with Product with Serializable
- case class PatternTokenizer(name: String, pattern: String = "\\W+", flags: String = "", group: Int = -1) extends Tokenizer with Product with Serializable
- case class ShingleTokenFilter(name: String, maxShingleSize: Option[Int] = None, minShingleSize: Option[Int] = None, outputUnigrams: Option[Boolean] = None, outputUnigramsIfNoShingles: Option[Boolean] = None, tokenSeparator: Option[String] = None, fillerToken: Option[String] = None) extends TokenFilter with Product with Serializable
- case class SnowballTokenFilter(name: String, language: String) extends TokenFilter with Product with Serializable
- case class StandardAnalyzer(name: String, stopwords: Iterable[String] = Nil, maxTokenLength: Int = 255) extends Analyzer with Product with Serializable
- case class StandardTokenizer(name: String, maxTokenLength: Int = 255) extends Tokenizer with Product with Serializable
- case class StemmerOverrideTokenFilter(name: String, rules: Seq[String] = Nil, rulesPath: Option[String] = None) extends TokenFilter with Product with Serializable
- case class StemmerTokenFilter(name: String, lang: String) extends TokenFilter with Product with Serializable
- case class StopAnalyzer(name: String, stopwords: Iterable[String] = Nil) extends Analyzer with Product with Serializable
- case class StopTokenFilter(name: String, language: Option[String] = None, stopwords: Iterable[String] = Nil, stopwordsPath: Option[String] = None, enablePositionIncrements: Option[Boolean] = None, removeTrailing: Option[Boolean] = None, ignoreCase: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class SynonymGraphTokenFilter(name: String, path: Option[String] = None, synonyms: Set[String] = Set.empty, ignoreCase: Option[Boolean] = None, format: Option[String] = None, expand: Option[Boolean] = None, tokenizer: Option[String] = None, updateable: Option[Boolean] = None, lenient: Option[Boolean] = None, synonymsSet: Option[String] = None) extends TokenFilter with Product with Serializable
- case class SynonymTokenFilter(name: String, path: Option[String] = None, synonyms: Set[String] = Set.empty, ignoreCase: Option[Boolean] = None, format: Option[String] = None, expand: Option[Boolean] = None, tokenizer: Option[String] = None, updateable: Option[Boolean] = None, lenient: Option[Boolean] = None, synonymsSet: Option[String] = None) extends TokenFilter with Product with Serializable
- case class ThaiTokenizer(name: String) extends Tokenizer with Product with Serializable
- trait TokenFilter extends AnyRef
- trait Tokenizer extends AnyRef
- case class TruncateTokenFilter(name: String, length: Int) extends TokenFilter with Product with Serializable
- case class UaxUrlEmailTokenizer(name: String, maxTokenLength: Int = 255) extends Tokenizer with Product with Serializable
- case class UniqueTokenFilter(name: String, onlyOnSamePosition: Boolean) extends TokenFilter with Product with Serializable
- case class WhitespaceTokenizer(name: String, maxTokenLength: Int) extends Tokenizer with Product with Serializable
- case class WordDelimiterGraphTokenFilter(name: String, preserveOriginal: Option[Boolean] = None, catenateNumbers: Option[Boolean] = None, catenateWords: Option[Boolean] = None, catenateAll: Option[Boolean] = None, generateWordParts: Option[Boolean] = None, generateNumberParts: Option[Boolean] = None, protectedWords: Option[String] = None, protectedWordsPath: Option[String] = None, splitOnCaseChange: Option[Boolean] = None, splitOnNumerics: Option[Boolean] = None, stem_english_possessive: Option[Boolean] = None, typeTable: Option[String] = None, typeTablePath: Option[String] = None, adjustOffsets: Option[Boolean] = None, ignoreKeywords: Option[Boolean] = None) extends TokenFilter with Product with Serializable
- case class WordDelimiterTokenFilter(name: String, generateWordParts: Option[Boolean] = None, generateNumberParts: Option[Boolean] = None, catenateWords: Option[Boolean] = None, catenateNumbers: Option[Boolean] = None, catenateAll: Option[Boolean] = None, splitOnCaseChange: Option[Boolean] = None, protectedWords: Option[String] = None, protectedWordsPath: Option[String] = None, preserveOriginal: Option[Boolean] = None, splitOnNumerics: Option[Boolean] = None, stemEnglishPossesive: Option[Boolean] = None, typeTable: Option[String] = None, typeTablePath: Option[String] = None) extends TokenFilter with Product with Serializable
Value Members
- object Analysis extends Serializable
- object AnalysisBuilder extends Builder[Analysis]
- object CustomAnalyzerBuilder extends Builder[CustomAnalyzer]
- case object DictionaryDecompounder extends CompoundWordTokenFilterType with Product with Serializable
- case object HyphenationDecompounder extends CompoundWordTokenFilterType with Product with Serializable
- object LanguageAnalyzers
- object NamedStopTokenFilter
- object NormalizerBuilder extends Builder[CustomNormalizer]