org.apache.solr.analysis

Class ICUCollationKeyFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.ICUCollationKeyFilterFactory

All Implemented Interfaces:

MultiTermAwareComponent, TokenFilterFactory, ResourceLoaderAware

public class ICUCollationKeyFilterFactory
extends BaseTokenFilterFactory
implements MultiTermAwareComponent, ResourceLoaderAware

Factory for ICUCollationKeyFilter.

This factory can be created in two ways:

• Based upon a system collator associated with a Locale.
• Based upon a tailored ruleset.

Using a System collator:

• locale: RFC 3066 locale ID (mandatory)
• strength: 'primary','secondary','tertiary', 'quaternary', or 'identical' (optional)
• decomposition: 'no', or 'canonical' (optional)

Using a Tailored ruleset:

• custom: UTF-8 text file containing rules supported by RuleBasedCollator (mandatory)
• strength: 'primary','secondary','tertiary', 'quaternary', or 'identical' (optional)
• decomposition: 'no' or 'canonical' (optional)

Expert options:

• alternate: 'shifted' or 'non-ignorable'. Can be used to ignore punctuation/whitespace.
• caseLevel: 'true' or 'false'. Useful with strength=primary to ignore accents but not case.
• caseFirst: 'lower' or 'upper'. Useful to control which is sorted first when case is not ignored.
• numeric: 'true' or 'false'. Digits are sorted according to numeric value, e.g. foobar-9 sorts before foobar-10
• variableTop: single character or contraction. Controls what is variable for 'alternate'

See Also:

Collator, ULocale, RuleBasedCollator

Field Summary

Fields

Modifier and Type	Field and Description
private com.ibm.icu.text.Collator	collator

Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory

log

Fields inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

args, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
ICUCollationKeyFilterFactory()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.TokenStream	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
private com.ibm.icu.text.Collator	createFromLocale(java.lang.String localeID)
private com.ibm.icu.text.Collator	createFromRules(java.lang.String fileName, ResourceLoader loader)
java.lang.Object	getMultiTermComponent() Returns an analysis component to handle analysis if multi-term queries.
void	inform(ResourceLoader loader)

Methods inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getSnowballWordSet, getWordSet, init, warnDeprecated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.analysis.TokenFilterFactory

getArgs, init

Field Detail

collator

private com.ibm.icu.text.Collator collator

Constructor Detail

ICUCollationKeyFilterFactory

public ICUCollationKeyFilterFactory()

Method Detail

inform

public void inform(ResourceLoader loader)

Specified by:

inform in interface ResourceLoaderAware

create

public org.apache.lucene.analysis.TokenStream create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in interface TokenFilterFactory

createFromLocale

private com.ibm.icu.text.Collator createFromLocale(java.lang.String localeID)

createFromRules

private com.ibm.icu.text.Collator createFromRules(java.lang.String fileName,
                                                  ResourceLoader loader)

getMultiTermComponent

public java.lang.Object 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