Package org.elasticsearch.index.analysis

Class NamedAnalyzer

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class NamedAnalyzer
extends org.apache.lucene.analysis.DelegatingAnalyzerWrapper
    Named analyzer is an analyzer wrapper around an actual analyzer (analyzer that is associated with a name (name().

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

        org.apache.lucene.analysis.Analyzer.ReuseStrategy, org.apache.lucene.analysis.Analyzer.TokenStreamComponents

    • Field Summary

      • Fields inherited from class org.apache.lucene.analysis.Analyzer

        GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

    • Method Summary

      Modifier and Type Method Description
      org.apache.lucene.analysis.Analyzer analyzer()
      The actual analyzer.
      void checkAllowedInMode​(AnalysisMode mode)
      Checks the wrapped analyzer for the provided restricted AnalysisMode and throws an error if the analyzer is not allowed to run in that mode.
      void close()  
      boolean equals​(java.lang.Object o)  
      AnalysisMode getAnalysisMode()
      Returns whether this analyzer can be updated
      int getPositionIncrementGap​(java.lang.String fieldName)  
      protected org.apache.lucene.analysis.Analyzer getWrappedAnalyzer​(java.lang.String fieldName)  
      int hashCode()  
      java.lang.String name()
      The name of the analyzer.
      AnalyzerScope scope()
      The scope of the analyzer.
      java.lang.String toString()  

      • Methods inherited from class org.apache.lucene.analysis.DelegatingAnalyzerWrapper

        wrapComponents, wrapReader, wrapReaderForNormalization, wrapTokenStreamForNormalization

      • Methods inherited from class org.apache.lucene.analysis.AnalyzerWrapper

        attributeFactory, createComponents, getOffsetGap, initReader, initReaderForNormalization, normalize

      • Methods inherited from class org.apache.lucene.analysis.Analyzer

        getReuseStrategy, getVersion, normalize, setVersion, tokenStream, tokenStream

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • NamedAnalyzer

        public NamedAnalyzer​(NamedAnalyzer analyzer,
                     int positionIncrementGap)

      • NamedAnalyzer

        public NamedAnalyzer​(java.lang.String name,
                     AnalyzerScope scope,
                     org.apache.lucene.analysis.Analyzer analyzer)

    • Method Detail

      • name

        public java.lang.String name()
        The name of the analyzer.

      • scope

        public AnalyzerScope scope()
        The scope of the analyzer.

      • getAnalysisMode

        public AnalysisMode getAnalysisMode()
        Returns whether this analyzer can be updated

      • analyzer

        public org.apache.lucene.analysis.Analyzer analyzer()
        The actual analyzer.

      • getWrappedAnalyzer

        protected org.apache.lucene.analysis.Analyzer getWrappedAnalyzer​(java.lang.String fieldName)
        Specified by:
        getWrappedAnalyzer in class org.apache.lucene.analysis.AnalyzerWrapper

      • getPositionIncrementGap

        public int getPositionIncrementGap​(java.lang.String fieldName)
        Overrides:
        getPositionIncrementGap in class org.apache.lucene.analysis.AnalyzerWrapper

      • checkAllowedInMode

        public void checkAllowedInMode​(AnalysisMode mode)
        Checks the wrapped analyzer for the provided restricted AnalysisMode and throws an error if the analyzer is not allowed to run in that mode. The error contains more detailed information about the offending filters that caused the analyzer to not be allowed in this mode.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • close

        public void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class org.apache.lucene.analysis.Analyzer