Class ICUCollationKeyAnalyzer

Configures KeywordTokenizer with ICUCollationAttributeFactory.

Inheritance
System.Object
Analyzer
ICUCollationKeyAnalyzer
Inherited Members
Lucene.Net.Analysis.Analyzer.NewAnonymous(System.Func<System.String, System.IO.TextReader, Lucene.Net.Analysis.TokenStreamComponents>)
Lucene.Net.Analysis.Analyzer.NewAnonymous(System.Func<System.String, System.IO.TextReader, Lucene.Net.Analysis.TokenStreamComponents>, Lucene.Net.Analysis.ReuseStrategy)
Lucene.Net.Analysis.Analyzer.NewAnonymous(System.Func<System.String, System.IO.TextReader, Lucene.Net.Analysis.TokenStreamComponents>, System.Func<System.String, System.IO.TextReader, System.IO.TextReader>)
Lucene.Net.Analysis.Analyzer.NewAnonymous(System.Func<System.String, System.IO.TextReader, Lucene.Net.Analysis.TokenStreamComponents>, System.Func<System.String, System.IO.TextReader, System.IO.TextReader>, Lucene.Net.Analysis.ReuseStrategy)
Lucene.Net.Analysis.Analyzer.CreateComponents(System.String, System.IO.TextReader)
Lucene.Net.Analysis.Analyzer.GetTokenStream(System.String, System.IO.TextReader)
Lucene.Net.Analysis.Analyzer.InitReader(System.String, System.IO.TextReader)
Lucene.Net.Analysis.Analyzer.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
Assembly: Lucene.Net.ICU.dll
Syntax
public sealed class ICUCollationKeyAnalyzer : Analyzer, IDisposable
Remarks

Converts the token into its , and then encodes the either directly or with IndexableBinaryStringTools (see below), to allow it to be stored as an index term.

WARNING: Make sure you use exactly the same at index and query time -- CollationKeys are only comparable when produced by the same . s are independently versioned, so it is safe to search against stored s if 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):

  1. Collator version - see Version
  2. The collation strength used - see

s generated by ICU Collators are not compatible with those generated by java.text.Collators. Specifically, if you use ICUCollationKeyAnalyzer to generate index terms, do not use CollationKeyAnalyzer on the query side, or vice versa.

ICUCollationKeyAnalyzer is 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.

You must specify the required LuceneVersion compatibility when creating ICUCollationKeyAnalyzer:

Constructors

Name Description
ICUCollationKeyAnalyzer(Collator)
ICUCollationKeyAnalyzer(LuceneVersion, Collator)

Create a new ICUCollationKeyAnalyzer, using the specified collator.

Methods

Name Description
CreateComponents(String, TextReader)

Extension Methods