org.elasticsearch.indices.analysis

Enum PreBuiltTokenizers

java.lang.Object

java.lang.Enum<PreBuiltTokenizers>

org.elasticsearch.indices.analysis.PreBuiltTokenizers

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASSIC
EDGE_NGRAM
KEYWORD
LETTER
LOWERCASE
NGRAM
PATH_HIERARCHY
PATTERN
STANDARD
THAI
UAX_URL_EMAIL
WHITESPACE

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.lucene.analysis.Tokenizer	create(Version version)
protected TokenFilterFactory	getMultiTermComponent(Version version)
static PreBuiltTokenizers	getOrDefault(java.lang.String name, PreBuiltTokenizers defaultTokenizer) Get a pre built Tokenizer by its name or fallback to the default one
TokenizerFactory	getTokenizerFactory(Version version)
static PreBuiltTokenizers	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PreBuiltTokenizers[]	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

STANDARD

public static final PreBuiltTokenizers STANDARD

CLASSIC

public static final PreBuiltTokenizers CLASSIC

UAX_URL_EMAIL

public static final PreBuiltTokenizers UAX_URL_EMAIL

PATH_HIERARCHY

public static final PreBuiltTokenizers PATH_HIERARCHY

KEYWORD

public static final PreBuiltTokenizers KEYWORD

LETTER

public static final PreBuiltTokenizers LETTER

LOWERCASE

public static final PreBuiltTokenizers LOWERCASE

WHITESPACE

public static final PreBuiltTokenizers WHITESPACE

NGRAM

public static final PreBuiltTokenizers NGRAM

EDGE_NGRAM

public static final PreBuiltTokenizers EDGE_NGRAM

PATTERN

public static final PreBuiltTokenizers PATTERN

THAI

public static final PreBuiltTokenizers THAI

Field Detail

cache

protected final PreBuiltCacheFactory.PreBuiltCache<TokenizerFactory> cache

Method Detail

values

public static PreBuiltTokenizers[] 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 (PreBuiltTokenizers c : PreBuiltTokenizers.values())
    System.out.println(c);

Returns:

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

valueOf

public static PreBuiltTokenizers 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

create

protected abstract org.apache.lucene.analysis.Tokenizer create(Version version)

getMultiTermComponent

protected TokenFilterFactory getMultiTermComponent(Version version)

getTokenizerFactory

public TokenizerFactory getTokenizerFactory(Version version)

getOrDefault

public static PreBuiltTokenizers getOrDefault(java.lang.String name,
                                              PreBuiltTokenizers defaultTokenizer)

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

Parameters:

name - Tokenizer name

defaultTokenizer - default Tokenizer if name not found