org.apache.solr.analysis
Class ICUCollationKeyFilterFactory

java.lang.Object
  org.apache.solr.analysis.BaseTokenFilterFactory
      org.apache.solr.analysis.ICUCollationKeyFilterFactory

All Implemented Interfaces:

org.apache.solr.analysis.MultiTermAwareComponent, org.apache.solr.analysis.TokenFilterFactory, org.apache.solr.util.plugin.ResourceLoaderAware

public class ICUCollationKeyFilterFactory
extends org.apache.solr.analysis.BaseTokenFilterFactory
implements org.apache.solr.analysis.MultiTermAwareComponent, org.apache.solr.util.plugin.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

protected Map<String,String>	args
protected Version	luceneMatchVersion

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

log

Constructor Summary

ICUCollationKeyFilterFactory()

Method Summary

protected void	assureMatchVersion()
TokenStream	create(TokenStream input)
Map<String,String>	getArgs()
protected boolean	getBoolean(String arg0, boolean arg1)
protected boolean	getBoolean(String arg0, boolean arg1, boolean arg2)
protected int	getInt(String arg0)
protected int	getInt(String arg0, int arg1)
protected int	getInt(String arg0, int arg1, boolean arg2)
Object	getMultiTermComponent()
protected CharArraySet	getSnowballWordSet(org.apache.solr.common.ResourceLoader arg0, String arg1, boolean arg2)
protected CharArraySet	getWordSet(org.apache.solr.common.ResourceLoader arg0, String arg1, boolean arg2)
void	inform(org.apache.solr.common.ResourceLoader loader)
void	init(Map<String,String> arg0)
protected void	warnDeprecated(String arg0)

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

args

protected Map<String,String> args

luceneMatchVersion

protected Version luceneMatchVersion

Constructor Detail

ICUCollationKeyFilterFactory

public ICUCollationKeyFilterFactory()

Method Detail

inform

public void inform(org.apache.solr.common.ResourceLoader loader)

Specified by:

inform in interface org.apache.solr.util.plugin.ResourceLoaderAware

create

public TokenStream create(TokenStream input)

Specified by:

create in interface org.apache.solr.analysis.TokenFilterFactory

getMultiTermComponent

public Object getMultiTermComponent()

Specified by:

getMultiTermComponent in interface org.apache.solr.analysis.MultiTermAwareComponent

init

public void init(Map<String,String> arg0)

getArgs

public Map<String,String> getArgs()

assureMatchVersion

protected final void assureMatchVersion()

warnDeprecated

protected final void warnDeprecated(String arg0)

getInt

protected int getInt(String arg0)

getInt

protected int getInt(String arg0,
                     int arg1)

getInt

protected int getInt(String arg0,
                     int arg1,
                     boolean arg2)

getBoolean

protected boolean getBoolean(String arg0,
                             boolean arg1)

getBoolean

protected boolean getBoolean(String arg0,
                             boolean arg1,
                             boolean arg2)

getWordSet

protected CharArraySet getWordSet(org.apache.solr.common.ResourceLoader arg0,
                                  String arg1,
                                  boolean arg2)
                           throws IOException

Throws:

IOException

getSnowballWordSet

protected CharArraySet getSnowballWordSet(org.apache.solr.common.ResourceLoader arg0,
                                          String arg1,
                                          boolean arg2)
                                   throws IOException

Throws:

IOException