Package org.elasticsearch.index.analysis
Enum Class AnalysisMode
<AnalysisMode>
org.elasticsearch.index.analysis.AnalysisMode
- All Implemented Interfaces:
,
<
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
Nested classes/interfaces inherited from class java.lang.
< extends <>>
-
Enum Constant Summary
Enum ConstantDescriptionAnalysisMode representing analysis components that can be used both at index and search timeAnalysisMode representing analysis components that can be used only at index timeAnalysisMode representing analysis components that can be used only at search time -
Method Summary
Modifier and TypeMethodDescriptionabstract 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 anstatic AnalysisMode
name)
Returns the enum constant of this class with the specified name.static AnalysisMode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.
, , , , , , , , , ,
Methods inherited from class java.lang.
, , , , ,
-
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 class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
public static name)Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
- if this enum class has no constant with the specified name
- if the argument is null
-
getReadableName
public 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
-