org.apache.solr.analysis

Class CollationKeyFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.CollationKeyFilterFactory

All Implemented Interfaces:

MultiTermAwareComponent, TokenFilterFactory, ResourceLoaderAware

public class CollationKeyFilterFactory
extends BaseTokenFilterFactory
implements MultiTermAwareComponent, ResourceLoaderAware

Factory for CollationKeyFilter.

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:

• language: ISO-639 language code (mandatory)
• country: ISO-3166 country code (optional)
• variant: vendor or browser-specific code (optional)
• strength: 'primary','secondary','tertiary', or 'identical' (optional)
• decomposition: 'no','canonical', or 'full' (optional)

Using a Tailored ruleset:

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

 <fieldType name="text_clltnky" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.KeywordTokenizerFactory"/>
     <filter class="solr.CollationKeyFilterFactory" language="ja" country="JP"/>
   </analyzer>
 </fieldType>

Since:

solr 3.1

See Also:

Collator, Locale, RuleBasedCollator

Field Summary

Fields

Modifier and Type	Field and Description
private java.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
CollationKeyFilterFactory()

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 java.text.Collator	createFromLocale(java.lang.String language, java.lang.String country, java.lang.String variant)
private java.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 java.text.Collator collator

Constructor Detail

CollationKeyFilterFactory

public CollationKeyFilterFactory()

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 java.text.Collator createFromLocale(java.lang.String language,
                                            java.lang.String country,
                                            java.lang.String variant)

createFromRules

private java.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