FixedShingleFilterFactory (Lucene 9.2.0 common API)

java.lang.Object
- org.apache.lucene.analysis.AbstractAnalysisFactory
- - org.apache.lucene.analysis.TokenFilterFactory
  - - org.apache.lucene.analysis.shingle.FixedShingleFilterFactory

```
public class FixedShingleFilterFactory
extends TokenFilterFactory
```
Factory for FixedShingleFilter
Parameters are:
- shingleSize - how many tokens should be combined into each shingle (default: 2)
- tokenSeparator - how tokens should be joined together in the shingle (default: space)
- fillerToken - what should be added in place of stop words (default: _ )
Since:

7.4.0

SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).

"fixedShingle"

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String NAME
  SPI name
  - Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
    LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
- Constructor Summary
  
  Constructors
  Constructor Description
  
  FixedShingleFilterFactory()
  Default ctor for compatibility with SPI
  
  FixedShingleFilterFactory(Map<String,String> args)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  TokenStream create(TokenStream input)
  - Methods inherited from class org.apache.lucene.analysis.TokenFilterFactory
    availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters
  - Methods inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
    defaultCtorException, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    SPI name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FixedShingleFilterFactory
```
public FixedShingleFilterFactory(Map<String,String> args)
```
  - FixedShingleFilterFactory
```
public FixedShingleFilterFactory()
```
    Default ctor for compatibility with SPI
- Method Detail
  - create
```
public TokenStream create(TokenStream input)
```
    Specified by:
    
    create in class TokenFilterFactory