Module org.apache.lucene.analysis.phonetic

Package org.apache.lucene.analysis.phonetic

Class DoubleMetaphoneFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

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

Since:

3.1

Field Summary

Fields

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

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DoubleMetaphoneFilter	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

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

inject

private final boolean inject

maxCodeLength

private final int maxCodeLength

Constructor Details

DoubleMetaphoneFilterFactory

public DoubleMetaphoneFilterFactory(Map<String,String> args)

Creates a new DoubleMetaphoneFilterFactory

DoubleMetaphoneFilterFactory

public DoubleMetaphoneFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public DoubleMetaphoneFilter create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory