Interface TokenFilterFactory

All Superinterfaces:
Nameable

public interface TokenFilterFactory extends Nameable
An analysis component used to create token filters.
  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.analysis.TokenStream
    create(org.apache.lucene.analysis.TokenStream tokenStream)
    Transform the specified input TokenStream.
    default AnalysisMode
    Get the AnalysisMode this filter is allowed to be used in.
    default org.apache.lucene.analysis.TokenStream
    normalize(org.apache.lucene.analysis.TokenStream tokenStream)
    Normalize a tokenStream for use in multi-term queries.

    Methods inherited from interface org.elasticsearch.plugin.Nameable

    name
  • Method Details

    • create

      org.apache.lucene.analysis.TokenStream create(org.apache.lucene.analysis.TokenStream tokenStream)
      Transform the specified input TokenStream.
      Parameters:
      tokenStream - a token stream to be transformed
      Returns:
      transformed token stream
    • normalize

      default org.apache.lucene.analysis.TokenStream normalize(org.apache.lucene.analysis.TokenStream tokenStream)
      Normalize a tokenStream for use in multi-term queries. The default implementation returns a given token stream.
    • getAnalysisMode

      default AnalysisMode getAnalysisMode()
      Get the AnalysisMode this filter is allowed to be used in. The default is AnalysisMode.ALL. Instances need to override this method to define their own restrictions.
      Returns:
      analysis mode