Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-1719: Add javadoc notes about ICUCollationKeyFilter's advantages over CollationKeyFilter (Steven Row via Simon Willnauer) 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@790262 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Simon Willnauer 2009-07-01 16:50:47 +00:00
parent 5265dc1bb2
commit 410afb98bf
4 changed files with 34 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
contrib/collation/src/java/org/apache/lucene/collation/CollationKeyAnalyzer.java
View File

@ -59,12 +59,17 @@ import java.io.IOException;
* </li> * </li>
* </ol> * </ol>
* <p> * <p>
* NB 1: {@link ICUCollationKeyAnalyzer} uses ICU4J's Collator, which makes * {@link ICUCollationKeyAnalyzer} uses ICU4J's Collator, which makes
* its version available, thus allowing collation to be versioned * its version available, thus allowing collation to be versioned
* independently from the JVM. * independently from the JVM. ICUCollationKeyAnalyzer is also significantly
* faster and generates significantly shorter keys than CollationKeyAnalyzer.
* See <a href="http://site.icu-project.org/charts/collation-icu4j-sun"
* >http://site.icu-project.org/charts/collation-icu4j-sun</a> for key
* generation timing and key length comparisons between ICU4J and
* java.text.Collator over several languages.
* </p> * </p>
* <p> * <p>
* NB 2: CollationKeys generated by java.text.Collators are not compatible * CollationKeys generated by java.text.Collators are not compatible
* with those those generated by ICU Collators. Specifically, if you use * with those those generated by ICU Collators. Specifically, if you use
* CollationKeyAnalyzer to generate index terms, do not use * CollationKeyAnalyzer to generate index terms, do not use
* ICUCollationKeyAnalyzer on the query side, or vice versa. * ICUCollationKeyAnalyzer on the query side, or vice versa.

11
contrib/collation/src/java/org/apache/lucene/collation/CollationKeyFilter.java
View File

@ -57,12 +57,17 @@ import java.text.Collator;
* </li> * </li>
* </ol> * </ol>
* <p> * <p>
* NB 1: {@link ICUCollationKeyFilter} uses ICU4J's Collator, which makes its * {@link ICUCollationKeyFilter} uses ICU4J's Collator, which makes its
* version available, thus allowing collation to be versioned independently * version available, thus allowing collation to be versioned independently
* from the JVM. * from the JVM. ICUCollationKeyFilter is also significantly faster and
* generates significantly shorter keys than CollationKeyFilter. See
* <a href="http://site.icu-project.org/charts/collation-icu4j-sun"
* >http://site.icu-project.org/charts/collation-icu4j-sun</a> for key
* generation timing and key length comparisons between ICU4J and
* java.text.Collator over several languages.
* </p> * </p>
* <p> * <p>
* NB 2: CollationKeys generated by java.text.Collators are not compatible * CollationKeys generated by java.text.Collators are not compatible
* with those those generated by ICU Collators. Specifically, if you use * with those those generated by ICU Collators. Specifically, if you use
* CollationKeyFilter to generate index terms, do not use * CollationKeyFilter to generate index terms, do not use
* {@link ICUCollationKeyFilter} on the query side, or vice versa. * {@link ICUCollationKeyFilter} on the query side, or vice versa.

10
contrib/collation/src/java/org/apache/lucene/collation/ICUCollationKeyAnalyzer.java
View File

@ -55,11 +55,19 @@ import java.io.IOException;
* </li> * </li>
* </ol> * </ol>
* <p> * <p>
* NB: CollationKeys generated by ICU Collators are not compatible with those * CollationKeys generated by ICU Collators are not compatible with those
* generated by java.text.Collators. Specifically, if you use * generated by java.text.Collators. Specifically, if you use
* ICUCollationKeyAnalyzer to generate index terms, do not use * ICUCollationKeyAnalyzer to generate index terms, do not use
* {@link CollationKeyAnalyzer} on the query side, or vice versa. * {@link CollationKeyAnalyzer} on the query side, or vice versa.
* </p> * </p>
* <p>
* ICUCollationKeyAnalyzer is significantly faster and generates significantly
* shorter keys than CollationKeyAnalyzer. See
* <a href="http://site.icu-project.org/charts/collation-icu4j-sun"
* >http://site.icu-project.org/charts/collation-icu4j-sun</a> for key
* generation timing and key length comparisons between ICU4J and
* java.text.Collator over several languages.
* </p>
*/ */
public class ICUCollationKeyAnalyzer extends Analyzer { public class ICUCollationKeyAnalyzer extends Analyzer {
private Collator collator; private Collator collator;

10
contrib/collation/src/java/org/apache/lucene/collation/ICUCollationKeyFilter.java
View File

@ -55,11 +55,19 @@ import java.nio.CharBuffer;
* </li> * </li>
* </ol> * </ol>
* <p> * <p>
* NB: CollationKeys generated by ICU Collators are not compatible with those * CollationKeys generated by ICU Collators are not compatible with those
* generated by java.text.Collators. Specifically, if you use * generated by java.text.Collators. Specifically, if you use
* ICUCollationKeyFilter to generate index terms, do not use * ICUCollationKeyFilter to generate index terms, do not use
* {@link CollationKeyFilter} on the query side, or vice versa. * {@link CollationKeyFilter} on the query side, or vice versa.
* </p> * </p>
* <p>
* ICUCollationKeyFilter is significantly faster and generates significantly
* shorter keys than CollationKeyFilter. See
* <a href="http://site.icu-project.org/charts/collation-icu4j-sun"
* >http://site.icu-project.org/charts/collation-icu4j-sun</a> for key
* generation timing and key length comparisons between ICU4J and
* java.text.Collator over several languages.
* </p>
*/ */
public class ICUCollationKeyFilter extends TokenFilter { public class ICUCollationKeyFilter extends TokenFilter {
private Collator collator = null; private Collator collator = null;