org.apache.lucene.analysis.icu

Class ICUNormalizer2FilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.TokenFilterFactory

org.apache.lucene.analysis.icu.ICUNormalizer2FilterFactory

All Implemented Interfaces:

MultiTermAwareComponent

public class ICUNormalizer2FilterFactory
extends TokenFilterFactory
implements MultiTermAwareComponent

Factory for ICUNormalizer2Filter

Supports the following attributes:

• name: A Unicode Normalization Form, one of 'nfc','nfkc', 'nfkc_cf'. Default is nfkc_cf.
• mode: Either 'compose' or 'decompose'. Default is compose. Use "decompose" with nfc or nfkc, to get nfd or nfkd, respectively.
• filter: A UnicodeSet pattern. Codepoints outside the set are always left unchanged. Default is [] (the null set, no filtering).

Since:

3.1.0

See Also:

ICUNormalizer2Filter, Normalizer2, FilteredNormalizer2

Field Summary

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
ICUNormalizer2FilterFactory(java.util.Map<java.lang.String,java.lang.String> args) Creates a new ICUNormalizer2FilterFactory

Method Summary

Modifier and Type	Method and Description
TokenStream	create(TokenStream input) Transform the specified input TokenStream
AbstractAnalysisFactory	getMultiTermComponent() Returns an analysis component to handle analysis if multi-term queries.

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

availableTokenFilters, forName, lookupClass, reloadTokenFilters

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

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

Constructor Detail

ICUNormalizer2FilterFactory

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

Creates a new ICUNormalizer2FilterFactory

Method Detail

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory

getMultiTermComponent

public AbstractAnalysisFactory getMultiTermComponent()

Description copied from interface: MultiTermAwareComponent

Returns an analysis component to handle analysis if multi-term queries. The returned component must be a TokenizerFactory, TokenFilterFactory or CharFilterFactory.

Specified by:

getMultiTermComponent in interface MultiTermAwareComponent