Package org.apache.lucene.analysis.shingle

Class FixedShingleFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.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

Field Summary

Fields

Modifier and Type	Field	Description
private final String	fillerToken
static final String	NAME	SPI name
private final int	shingleSize
private final String	tokenSeparator

Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
FixedShingleFilterFactory(Map<String,String> args)

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream input)	Transform the specified input TokenStream

Methods inherited from class org.apache.lucene.analysis.util.TokenFilterFactory

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

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 Details

NAME

public static final String NAME

SPI name

See Also:

• Constant Field Values

shingleSize

private final int shingleSize

tokenSeparator

private final String tokenSeparator

fillerToken

private final String fillerToken

Constructor Details

FixedShingleFilterFactory

public FixedShingleFilterFactory(Map<String,String> args)

Method Details

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory