org.apache.solr.analysis
Class NGramTokenizerFactory

java.lang.Object
  org.apache.solr.analysis.BaseTokenizerFactory
      org.apache.solr.analysis.NGramTokenizerFactory

All Implemented Interfaces:

TokenizerFactory

public class NGramTokenizerFactory
extends BaseTokenizerFactory

Creates new instances of NGramTokenizer.

Field Summary

protected java.util.Map<java.lang.String,java.lang.String>	args The init args
protected org.apache.lucene.util.Version	luceneMatchVersion the luceneVersion arg

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

log

Constructor Summary

NGramTokenizerFactory()

Method Summary

protected void	assureMatchVersion() this method can be called in the #create method, to inform user, that for this factory a luceneMatchVersion is required
org.apache.lucene.analysis.ngram.NGramTokenizer	create(java.io.Reader input) Creates the TokenStream of n-grams from the given Reader.
java.util.Map<java.lang.String,java.lang.String>	getArgs()
protected boolean	getBoolean(java.lang.String name, boolean defaultVal)
protected boolean	getBoolean(java.lang.String name, boolean defaultVal, boolean useDefault)
protected int	getInt(java.lang.String name)
protected int	getInt(java.lang.String name, int defaultVal)
protected int	getInt(java.lang.String name, int defaultVal, boolean useDefault)
protected org.apache.lucene.analysis.CharArraySet	getWordSet(ResourceLoader loader, java.lang.String wordFiles, boolean ignoreCase)
void	init(java.util.Map<java.lang.String,java.lang.String> args) Initializes the n-gram min and max sizes and the side from which one should start tokenizing.

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.TokenizerFactory

getArgs

Field Detail

args

protected java.util.Map<java.lang.String,java.lang.String> args

The init args

luceneMatchVersion

protected org.apache.lucene.util.Version luceneMatchVersion

the luceneVersion arg

Constructor Detail

NGramTokenizerFactory

public NGramTokenizerFactory()

Method Detail

init

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

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

Specified by:

init in interface TokenizerFactory

create

public org.apache.lucene.analysis.ngram.NGramTokenizer create(java.io.Reader input)

Creates the TokenStream of n-grams from the given Reader.

getArgs

public java.util.Map<java.lang.String,java.lang.String> getArgs()

assureMatchVersion

protected final void assureMatchVersion()

this method can be called in the #create method, to inform user, that for this factory a luceneMatchVersion is required

getInt

protected int getInt(java.lang.String name)

getInt

protected int getInt(java.lang.String name,
                     int defaultVal)

getInt

protected int getInt(java.lang.String name,
                     int defaultVal,
                     boolean useDefault)

getBoolean

protected boolean getBoolean(java.lang.String name,
                             boolean defaultVal)

getBoolean

protected boolean getBoolean(java.lang.String name,
                             boolean defaultVal,
                             boolean useDefault)

getWordSet

protected org.apache.lucene.analysis.CharArraySet getWordSet(ResourceLoader loader,
                                                             java.lang.String wordFiles,
                                                             boolean ignoreCase)
                                                      throws java.io.IOException

Throws:

java.io.IOException