Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.miscellaneous

Class ASCIIFoldingFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.miscellaneous.ASCIIFoldingFilterFactory

public class ASCIIFoldingFilterFactory
extends TokenFilterFactory

Factory for ASCIIFoldingFilter.

 <fieldType name="text_ascii" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.ASCIIFoldingFilterFactory" preserveOriginal="false"/>
   </analyzer>
 </fieldType>

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	SPI name
private static final String	PRESERVE_ORIGINAL
private final boolean	preserveOriginal

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream input)	Transform the specified input TokenStream
TokenStream	normalize(TokenStream input)	Normalize the specified input TokenStream While the default implementation returns input unchanged, filters that should be applied at normalization time can delegate to create method.

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

availableTokenFilters, findSPIName, forName, lookupClass, 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

PRESERVE_ORIGINAL

private static final String PRESERVE_ORIGINAL

See Also:

• Constant Field Values

preserveOriginal

private final boolean preserveOriginal

Constructor Details

ASCIIFoldingFilterFactory

public ASCIIFoldingFilterFactory(Map<String,String> args)

Creates a new ASCIIFoldingFilterFactory

ASCIIFoldingFilterFactory

public ASCIIFoldingFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory

normalize

public TokenStream normalize(TokenStream input)

Description copied from class: TokenFilterFactory

Normalize the specified input TokenStream While the default implementation returns input unchanged, filters that should be applied at normalization time can delegate to create method.

Overrides:

normalize in class TokenFilterFactory