org.apache.solr.analysis

Class NGramFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.NGramFilterFactory

All Implemented Interfaces:

TokenFilterFactory

public class NGramFilterFactory
extends BaseTokenFilterFactory

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"/>
   </analyzer>
 </fieldType>

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field and Description
private int	maxGramSize
private int	minGramSize

Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory

log

Fields inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

args, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
NGramFilterFactory()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.ngram.NGramTokenFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
void	init(java.util.Map<java.lang.String,java.lang.String> args) Initialize the n-gram min and max sizes and the side from which one should start tokenizing.

Methods inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getSnowballWordSet, getWordSet, warnDeprecated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.analysis.TokenFilterFactory

getArgs

Field Detail

maxGramSize

private int maxGramSize

minGramSize

private int minGramSize

Constructor Detail

NGramFilterFactory

public NGramFilterFactory()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> args)

Initialize the n-gram min and max sizes and the side from which one should start tokenizing.

Specified by:

init in interface TokenFilterFactory

Overrides:

init in class BaseTokenStreamFactory

create

public org.apache.lucene.analysis.ngram.NGramTokenFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream