org.apache.lucene.analysis.phonetic

Class DoubleMetaphoneFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.TokenFilterFactory

org.apache.lucene.analysis.phonetic.DoubleMetaphoneFilterFactory

public class DoubleMetaphoneFilterFactory
extends TokenFilterFactory

Factory for DoubleMetaphoneFilter.

 <fieldType name="text_dblmtphn" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.DoubleMetaphoneFilterFactory" inject="true" maxCodeLength="4"/>
   </analyzer>
 </fieldType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CODE_LENGTH default maxCodeLength if not specified
static String	INJECT parameter name: true if encoded tokens should be added as synonyms
static String	MAX_CODE_LENGTH parameter name: restricts the length of the phonetic code

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

args, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
DoubleMetaphoneFilterFactory() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DoubleMetaphoneFilter	create(TokenStream input)
void	init(Map<String,String> args)

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

availableTokenFilters, forName, lookupClass, reloadTokenFilters

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

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getLines, getLuceneMatchVersion, getPattern, getSnowballWordSet, getWordSet, setLuceneMatchVersion, splitFileNames

Methods inherited from class java.lang.Object

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

Field Detail

INJECT

public static final String INJECT

parameter name: true if encoded tokens should be added as synonyms

See Also:

Constant Field Values

MAX_CODE_LENGTH

public static final String MAX_CODE_LENGTH

parameter name: restricts the length of the phonetic code

See Also:

Constant Field Values

DEFAULT_MAX_CODE_LENGTH

public static final int DEFAULT_MAX_CODE_LENGTH

default maxCodeLength if not specified

See Also:

Constant Field Values

Constructor Detail

DoubleMetaphoneFilterFactory

public DoubleMetaphoneFilterFactory()

Sole constructor. See AbstractAnalysisFactory for initialization lifecycle.

Method Detail

init

public void init(Map<String,String> args)

Overrides:

init in class AbstractAnalysisFactory

create

public DoubleMetaphoneFilter create(TokenStream input)

Specified by:

create in class TokenFilterFactory