Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.ngram

Class NGramFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.ngram.NGramFilterFactory

public class NGramFilterFactory
extends TokenFilterFactory

Factory for NGramTokenFilter.

 <fieldType name="text_ngrm" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.NGramFilterFactory" minGramSize="1" maxGramSize="2" preserveOriginal="true"/>
   </analyzer>
 </fieldType>

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
private final int	maxGramSize
private final int	minGramSize
static final String	NAME	SPI name
private final boolean	preserveOriginal

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
NGramFilterFactory()	Default ctor for compatibility with SPI
NGramFilterFactory(Map<String,String> args)	Creates a new NGramFilterFactory

Method Summary

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

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 Details

NAME

public static final String NAME

SPI name

See Also:

• Constant Field Values

maxGramSize

private final int maxGramSize

minGramSize

private final int minGramSize

preserveOriginal

private final boolean preserveOriginal

Constructor Details

NGramFilterFactory

public NGramFilterFactory(Map<String,String> args)

Creates a new NGramFilterFactory

NGramFilterFactory

public NGramFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public TokenFilter create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory