Class SnowballFilter

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public final class SnowballFilter
    extends org.apache.lucene.analysis.TokenFilter
    A filter that stems words using a Snowball-generated stemmer. Available stemmers are listed in org.tartarus.snowball.ext.

    NOTE: SnowballFilter expects lowercased text.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

        org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State
    • Field Summary

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

        input
    • Constructor Summary

      Constructors 
      Constructor Description
      SnowballFilter​(org.apache.lucene.analysis.TokenStream in, String name)
      Construct the named stemming filter.
      SnowballFilter​(org.apache.lucene.analysis.TokenStream input, SnowballProgram stemmer)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean incrementToken()
      Returns the next input Token, after being stemmed
      • Methods inherited from class org.apache.lucene.analysis.TokenFilter

        close, end, reset
      • Methods inherited from class org.apache.lucene.util.AttributeSource

        addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
    • Constructor Detail

      • SnowballFilter

        public SnowballFilter​(org.apache.lucene.analysis.TokenStream input,
                              SnowballProgram stemmer)
      • SnowballFilter

        public SnowballFilter​(org.apache.lucene.analysis.TokenStream in,
                              String name)
        Construct the named stemming filter. Available stemmers are listed in org.tartarus.snowball.ext. The name of a stemmer is the part of the class name before "Stemmer", e.g., the stemmer in EnglishStemmer is named "English".
        Parameters:
        in - the input tokens to stem
        name - the name of a stemmer
    • Method Detail

      • incrementToken

        public final boolean incrementToken()
                                     throws IOException
        Returns the next input Token, after being stemmed
        Specified by:
        incrementToken in class org.apache.lucene.analysis.TokenStream
        Throws:
        IOException