Package org.elasticsearch.index.analysis

Enum Class AnalysisMode

<AnalysisMode>
org.elasticsearch.index.analysis.AnalysisMode
All Implemented Interfaces:
, <
public enum AnalysisMode extends <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

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL
    AnalysisMode representing analysis components that can be used both at index and search time
    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

  • Method Summary

    Modifier and Type
    Method
    Description
    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 an
    static 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

      public static final AnalysisMode INDEX_TIME
      AnalysisMode representing analysis components that can be used only at index time

    • SEARCH_TIME

      public static final AnalysisMode SEARCH_TIME
      AnalysisMode representing analysis components that can be used only at search time

    • ALL

      public static final AnalysisMode ALL
      AnalysisMode representing analysis components that can be used both at index and search time

  • Method Details

    • values

      public static AnalysisMode[] 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

      public 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 an