Class NGramTokenFilter

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public final class NGramTokenFilter
    extends org.apache.lucene.analysis.TokenFilter
    Tokenizes the input into n-grams of the given size(s).
    • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      NGramTokenFilter​(org.apache.lucene.analysis.TokenStream input)
      Creates NGramTokenFilter with default min and max n-grams.
      NGramTokenFilter​(org.apache.lucene.analysis.TokenStream input, int minGram, int maxGram)
      Creates NGramTokenFilter with given min and max n-grams.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean incrementToken()
      Returns the next token in the stream, or null at EOS.
      void reset()  
      • Methods inherited from class org.apache.lucene.analysis.TokenFilter

        close, end
      • 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

      • NGramTokenFilter

        public NGramTokenFilter​(org.apache.lucene.analysis.TokenStream input,
                                int minGram,
                                int maxGram)
        Creates NGramTokenFilter with given min and max n-grams.
        Parameters:
        input - TokenStream holding the input to be tokenized
        minGram - the smallest n-gram to generate
        maxGram - the largest n-gram to generate
      • NGramTokenFilter

        public NGramTokenFilter​(org.apache.lucene.analysis.TokenStream input)
        Creates NGramTokenFilter with default min and max n-grams.
        Parameters:
        input - TokenStream holding the input to be tokenized
    • Method Detail

      • incrementToken

        public final boolean incrementToken()
                                     throws IOException
        Returns the next token in the stream, or null at EOS.
        Specified by:
        incrementToken in class org.apache.lucene.analysis.TokenStream
        Throws:
        IOException
      • reset

        public void reset()
                   throws IOException
        Overrides:
        reset in class org.apache.lucene.analysis.TokenFilter
        Throws:
        IOException