Class EdgeNGramTokenFilter

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public final class EdgeNGramTokenFilter
    extends org.apache.lucene.analysis.TokenFilter
    Tokenizes the given token into n-grams of given size(s).

    This TokenFilter create n-grams from the beginning edge or ending edge of a input token.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  EdgeNGramTokenFilter.Side
      Specifies which side of the input the n-gram should be generated from
      • 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
      EdgeNGramTokenFilter​(org.apache.lucene.analysis.TokenStream input, String sideLabel, int minGram, int maxGram)
      Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
      EdgeNGramTokenFilter​(org.apache.lucene.analysis.TokenStream input, EdgeNGramTokenFilter.Side side, int minGram, int maxGram)
      Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean incrementToken()  
      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

      • EdgeNGramTokenFilter

        public EdgeNGramTokenFilter​(org.apache.lucene.analysis.TokenStream input,
                                    EdgeNGramTokenFilter.Side side,
                                    int minGram,
                                    int maxGram)
        Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
        Parameters:
        input - TokenStream holding the input to be tokenized
        side - the EdgeNGramTokenFilter.Side from which to chop off an n-gram
        minGram - the smallest n-gram to generate
        maxGram - the largest n-gram to generate
      • EdgeNGramTokenFilter

        public EdgeNGramTokenFilter​(org.apache.lucene.analysis.TokenStream input,
                                    String sideLabel,
                                    int minGram,
                                    int maxGram)
        Creates EdgeNGramTokenFilter that can generate n-grams in the sizes of the given range
        Parameters:
        input - TokenStream holding the input to be tokenized
        sideLabel - the name of the EdgeNGramTokenFilter.Side from which to chop off an n-gram
        minGram - the smallest n-gram to generate
        maxGram - the largest n-gram to generate
    • Method Detail

      • incrementToken

        public final boolean incrementToken()
                                     throws IOException
        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