Module org.apache.lucene.analysis.icu

Package org.apache.lucene.analysis.icu

Class ICUTransformFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.icu.ICUTransformFilterFactory

public class ICUTransformFilterFactory
extends TokenFilterFactory

Factory for ICUTransformFilter.

Supports the following attributes:

• id (mandatory): A Transliterator ID, one from Transliterator.getAvailableIDs()
• direction (optional): Either 'forward' or 'reverse'. Default is forward.

Since:

3.1.0

See Also:

• Transliterator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	SPI name
private final com.ibm.icu.text.Transliterator	transliterator

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

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

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

transliterator

private final com.ibm.icu.text.Transliterator transliterator

Constructor Details

ICUTransformFilterFactory

public ICUTransformFilterFactory(Map<String,String> args)

Creates a new ICUTransformFilterFactory

ICUTransformFilterFactory

public ICUTransformFilterFactory()

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