public class CollationKeyAnalyzer
extends org.apache.lucene.analysis.Analyzer
Filters KeywordTokenizer
with CollationKeyFilter
.
Converts the token into its CollationKey
, and then
encodes the CollationKey with
IndexableBinaryStringTools
, to allow
it to be stored as an index term.
WARNING: Make sure you use exactly the same Collator at
index and query time -- CollationKeys are only comparable when produced by
the same Collator. Since RuleBasedCollator
s are not
independently versioned, it is unsafe to search against stored
CollationKeys unless the following are exactly the same (best practice is
to store this information with the index and check that they remain the
same at query time):
Collator.getInstance(java.util.Locale)
.
Collator.setStrength(int)
ICUCollationKeyAnalyzer
uses ICU4J's Collator, which makes
its version available, thus allowing collation to be versioned
independently from the JVM. ICUCollationKeyAnalyzer is also significantly
faster and generates significantly shorter keys than CollationKeyAnalyzer.
See http://site.icu-project.org/charts/collation-icu4j-sun for key
generation timing and key length comparisons between ICU4J and
java.text.Collator over several languages.
CollationKeys generated by java.text.Collators are not compatible with those those generated by ICU Collators. Specifically, if you use CollationKeyAnalyzer to generate index terms, do not use ICUCollationKeyAnalyzer on the query side, or vice versa.
Constructor and Description |
---|
CollationKeyAnalyzer(Collator collator) |
Modifier and Type | Method and Description |
---|---|
org.apache.lucene.analysis.TokenStream |
reusableTokenStream(String fieldName,
Reader reader) |
org.apache.lucene.analysis.TokenStream |
tokenStream(String fieldName,
Reader reader) |
public CollationKeyAnalyzer(Collator collator)
public org.apache.lucene.analysis.TokenStream tokenStream(String fieldName, Reader reader)
tokenStream
in class org.apache.lucene.analysis.Analyzer
public org.apache.lucene.analysis.TokenStream reusableTokenStream(String fieldName, Reader reader) throws IOException
reusableTokenStream
in class org.apache.lucene.analysis.Analyzer
IOException
Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.