Package org.elasticsearch.index.analysis
Enum AnalysisMode
java.lang.Object
java.lang.Enum<AnalysisMode>
org.elasticsearch.index.analysis.AnalysisMode
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AnalysisMode>
,java.lang.constant.Constable
public enum AnalysisMode extends java.lang.Enum<AnalysisMode>
Enum representing the mode in which token filters and analyzers are allowed to operate.
While most token filters are allowed both in index and search time analyzers, some are
restricted to be used only at index time, others at search time.
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL
AnalysisMode representing analysis components that can be used both at index and search timeINDEX_TIME
AnalysisMode representing analysis components that can be used only at index timeSEARCH_TIME
AnalysisMode representing analysis components that can be used only at search time -
Method Summary
Modifier and Type Method Description java.lang.String
getReadableName()
abstract AnalysisMode
merge(AnalysisMode other)
Returns a mode that is compatible with both this mode and the other mode, that is: ALL.merge(INDEX_TIME) == INDEX_TIME ALL.merge(SEARCH_TIME) == SEARCH_TIME INDEX_TIME.merge(SEARCH_TIME) throws anIllegalStateException
static AnalysisMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AnalysisMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
INDEX_TIME
AnalysisMode representing analysis components that can be used only at index time -
SEARCH_TIME
AnalysisMode representing analysis components that can be used only at search time -
ALL
AnalysisMode representing analysis components that can be used both at index and search time
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 namejava.lang.NullPointerException
- if the argument is null
-
getReadableName
public java.lang.String getReadableName() -
merge
Returns a mode that is compatible with both this mode and the other mode, that is:- ALL.merge(INDEX_TIME) == INDEX_TIME
- ALL.merge(SEARCH_TIME) == SEARCH_TIME
- INDEX_TIME.merge(SEARCH_TIME) throws an
IllegalStateException
-