EdgeNGramTokenFilter (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter

```
public 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 and 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`EdgeNGramTokenFilter.Side` Specifies which side of the input the n-gram should be generated from

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_GRAM_SIZE

static int DEFAULT_MIN_GRAM_SIZE

static EdgeNGramTokenFilter.Side DEFAULT_SIDE
- Fields inherited from class org.apache.lucene.analysis.TokenFilter
  input

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_GRAM_SIZE`
`static int`	`DEFAULT_MIN_GRAM_SIZE`
`static EdgeNGramTokenFilter.Side`	`DEFAULT_SIDE`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input)`
	`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
	`EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input, java.lang.String sideLabel, 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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`incrementToken()`
`org.apache.lucene.analysis.Token`	`next()` Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
`org.apache.lucene.analysis.Token`	`next(org.apache.lucene.analysis.Token reusableToken)` Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
`void`	`reset()`

Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end

Methods inherited from class org.apache.lucene.analysis.TokenStream
getOnlyUseNewAPI, setOnlyUseNewAPI

Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SIDE
```
public static final EdgeNGramTokenFilter.Side DEFAULT_SIDE
```
  - DEFAULT_MAX_GRAM_SIZE
```
public static final int DEFAULT_MAX_GRAM_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_GRAM_SIZE
```
public static final int DEFAULT_MIN_GRAM_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EdgeNGramTokenFilter
```
protected EdgeNGramTokenFilter(org.apache.lucene.analysis.TokenStream input)
```
  - 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,
                            java.lang.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 java.io.IOException
```
    Overrides:
    
    incrementToken in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - next
```
public final org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token reusableToken)
                                            throws java.io.IOException
```
    Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
    
    Overrides:
    
    next in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - next
```
public final org.apache.lucene.analysis.Token next()
                                            throws java.io.IOException
```
    Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
    
    Overrides:
    
    next in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
           throws java.io.IOException
```
    Overrides:
    
    reset in class org.apache.lucene.analysis.TokenFilter
    
    Throws:
    
    java.io.IOException

Class EdgeNGramTokenFilter

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.analysis.TokenFilter

Methods inherited from class org.apache.lucene.analysis.TokenStream

Methods inherited from class org.apache.lucene.util.AttributeSource

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SIDE

DEFAULT_MAX_GRAM_SIZE

DEFAULT_MIN_GRAM_SIZE

Constructor Detail

EdgeNGramTokenFilter

EdgeNGramTokenFilter

EdgeNGramTokenFilter

Method Detail

incrementToken

next

next

reset