org.elasticsearch.indices.analysis

Enum PreBuiltTokenFilters

java.lang.Object

java.lang.Enum<PreBuiltTokenFilters>

org.elasticsearch.indices.analysis.PreBuiltTokenFilters

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreBuiltTokenFilters>

public enum PreBuiltTokenFilters
extends java.lang.Enum<PreBuiltTokenFilters>

Enum Constant Summary

Enum Constants

Enum Constant and Description
APOSTROPHE
ARABIC_NORMALIZATION
ARABIC_STEM
ASCIIFOLDING
BRAZILIAN_STEM
CJK_BIGRAM
CJK_WIDTH
CLASSIC
COMMON_GRAMS
CZECH_STEM
DECIMAL_DIGIT
DELIMITED_PAYLOAD_FILTER
DUTCH_STEM
EDGE_NGRAM
ELISION
FRENCH_STEM
GERMAN_NORMALIZATION
GERMAN_STEM
HINDI_NORMALIZATION
INDIC_NORMALIZATION
KEYWORD_REPEAT
KSTEM
LENGTH
LIMIT
LOWERCASE
NGRAM
PERSIAN_NORMALIZATION
PORTER_STEM
REVERSE
RUSSIAN_STEM
SCANDINAVIAN_FOLDING
SCANDINAVIAN_NORMALIZATION
SHINGLE
SNOWBALL
SORANI_NORMALIZATION
STANDARD
STEMMER
STOP
TRIM
TRUNCATE
TYPE_AS_PAYLOAD
UNIQUE
UPPERCASE
WORD_DELIMITER
WORD_DELIMITER_GRAPH

Field Summary

Fields

Modifier and Type	Field and Description
protected PreBuiltCacheFactory.PreBuiltCache<TokenFilterFactory>	cache

Method Summary

Modifier and Type	Method and Description
abstract org.apache.lucene.analysis.TokenStream	create(org.apache.lucene.analysis.TokenStream tokenStream, Version version)
static PreBuiltTokenFilters	getOrDefault(java.lang.String name, PreBuiltTokenFilters defaultTokenFilter) Get a pre built TokenFilter by its name or fallback to the default one
TokenFilterFactory	getTokenFilterFactory(Version version)
protected boolean	isMultiTermAware()
static PreBuiltTokenFilters	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PreBuiltTokenFilters[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORD_DELIMITER

public static final PreBuiltTokenFilters WORD_DELIMITER

WORD_DELIMITER_GRAPH

public static final PreBuiltTokenFilters WORD_DELIMITER_GRAPH

STOP

public static final PreBuiltTokenFilters STOP

TRIM

public static final PreBuiltTokenFilters TRIM

REVERSE

public static final PreBuiltTokenFilters REVERSE

ASCIIFOLDING

public static final PreBuiltTokenFilters ASCIIFOLDING

LENGTH

public static final PreBuiltTokenFilters LENGTH

COMMON_GRAMS

public static final PreBuiltTokenFilters COMMON_GRAMS

LOWERCASE

public static final PreBuiltTokenFilters LOWERCASE

UPPERCASE

public static final PreBuiltTokenFilters UPPERCASE

KSTEM

public static final PreBuiltTokenFilters KSTEM

PORTER_STEM

public static final PreBuiltTokenFilters PORTER_STEM

STANDARD

public static final PreBuiltTokenFilters STANDARD

CLASSIC

public static final PreBuiltTokenFilters CLASSIC

NGRAM

public static final PreBuiltTokenFilters NGRAM

EDGE_NGRAM

public static final PreBuiltTokenFilters EDGE_NGRAM

UNIQUE

public static final PreBuiltTokenFilters UNIQUE

TRUNCATE

public static final PreBuiltTokenFilters TRUNCATE

SNOWBALL

public static final PreBuiltTokenFilters SNOWBALL

STEMMER

public static final PreBuiltTokenFilters STEMMER

ELISION

public static final PreBuiltTokenFilters ELISION

ARABIC_STEM

public static final PreBuiltTokenFilters ARABIC_STEM

BRAZILIAN_STEM

public static final PreBuiltTokenFilters BRAZILIAN_STEM

CZECH_STEM

public static final PreBuiltTokenFilters CZECH_STEM

DUTCH_STEM

public static final PreBuiltTokenFilters DUTCH_STEM

FRENCH_STEM

public static final PreBuiltTokenFilters FRENCH_STEM

GERMAN_STEM

public static final PreBuiltTokenFilters GERMAN_STEM

RUSSIAN_STEM

public static final PreBuiltTokenFilters RUSSIAN_STEM

KEYWORD_REPEAT

public static final PreBuiltTokenFilters KEYWORD_REPEAT

ARABIC_NORMALIZATION

public static final PreBuiltTokenFilters ARABIC_NORMALIZATION

PERSIAN_NORMALIZATION

public static final PreBuiltTokenFilters PERSIAN_NORMALIZATION

TYPE_AS_PAYLOAD

public static final PreBuiltTokenFilters TYPE_AS_PAYLOAD

SHINGLE

public static final PreBuiltTokenFilters SHINGLE

GERMAN_NORMALIZATION

public static final PreBuiltTokenFilters GERMAN_NORMALIZATION

HINDI_NORMALIZATION

public static final PreBuiltTokenFilters HINDI_NORMALIZATION

INDIC_NORMALIZATION

public static final PreBuiltTokenFilters INDIC_NORMALIZATION

SORANI_NORMALIZATION

public static final PreBuiltTokenFilters SORANI_NORMALIZATION

SCANDINAVIAN_NORMALIZATION

public static final PreBuiltTokenFilters SCANDINAVIAN_NORMALIZATION

SCANDINAVIAN_FOLDING

public static final PreBuiltTokenFilters SCANDINAVIAN_FOLDING

APOSTROPHE

public static final PreBuiltTokenFilters APOSTROPHE

CJK_WIDTH

public static final PreBuiltTokenFilters CJK_WIDTH

DECIMAL_DIGIT

public static final PreBuiltTokenFilters DECIMAL_DIGIT

CJK_BIGRAM

public static final PreBuiltTokenFilters CJK_BIGRAM

DELIMITED_PAYLOAD_FILTER

public static final PreBuiltTokenFilters DELIMITED_PAYLOAD_FILTER

LIMIT

public static final PreBuiltTokenFilters LIMIT

Field Detail

cache

protected final PreBuiltCacheFactory.PreBuiltCache<TokenFilterFactory> cache

Method Detail

values

public static PreBuiltTokenFilters[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PreBuiltTokenFilters c : PreBuiltTokenFilters.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PreBuiltTokenFilters valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isMultiTermAware

protected boolean isMultiTermAware()

create

public abstract org.apache.lucene.analysis.TokenStream create(org.apache.lucene.analysis.TokenStream tokenStream,
                                                              Version version)

getTokenFilterFactory

public TokenFilterFactory getTokenFilterFactory(Version version)

getOrDefault

public static PreBuiltTokenFilters getOrDefault(java.lang.String name,
                                                PreBuiltTokenFilters defaultTokenFilter)

Get a pre built TokenFilter by its name or fallback to the default one

Parameters:

name - TokenFilter name

defaultTokenFilter - default TokenFilter if name not found