Permalink
Browse files

release 1.1.0

  • Loading branch information...
kimchy committed Dec 13, 2011
1 parent 7cb31ac commit b61e27eccc73f389602aff4648c8c9a8406fc0c6
Showing with 100 additions and 3 deletions.
  1. +99 −1 README.md
  2. +1 −1 pom.xml
  3. +0 −1 src/main/java/org/elasticsearch/index/analysis/IcuTransformTokenFilterFactory.java
View
100 README.md
@@ -3,13 +3,111 @@ ICU Analysis for ElasticSearch
The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.
-In order to install the plugin, simply run: `bin/plugin -install elasticsearch/elasticsearch-analysis-icu/1.0.0`.
+In order to install the plugin, simply run: `bin/plugin -install elasticsearch/elasticsearch-analysis-icu/1.1.0`.
----------------------------------------
| ICU Analysis Plugin | ElasticSearch |
----------------------------------------
| master | 0.18 -> master |
----------------------------------------
+ | 1.1.0 | 0.18 -> master |
+ ----------------------------------------
| 1.0.0 | 0.18 -> master |
----------------------------------------
+
+ICU Normalization
+-----------------
+
+Normalizes characters as explained "here":http://userguide.icu-project.org/transforms/normalization. It registers itself by default under @icu_normalizer@ or @icuNormalizer@ using the default settings. Allows for the name parameter to be provided which can include the following values: @nfc@, @nfkc@, and @nfkc_cf@. Here is a sample settings:
+
+ {
+ "index" : {
+ "analysis" : {
+ "analyzer" : {
+ "collation" : {
+ "tokenizer" : "keyword",
+ "filter" : ["icu_normalizer"]
+ }
+ }
+ }
+ }
+ }
+
+ICU Folding
+-----------
+
+Folding of unicode characters based on @UTR#30@. It registers itself under @icu_folding@ and @icuFolding@ names. Sample setting:
+
+ {
+ "index" : {
+ "analysis" : {
+ "analyzer" : {
+ "collation" : {
+ "tokenizer" : "keyword",
+ "filter" : ["icu_folding"]
+ }
+ }
+ }
+ }
+ }
+
+ICU Collation
+-------------
+
+Uses collation token filter. Allows to either specify the rules for collation (defined "here":http://www.icu-project.org/userguide/Collate_Customization.html) using the @rules@ parameter (can point to a location or expressed in the settings, location can be relative to config location), or using the @language@ parameter (further specialized by country and variant). By default registers under @icu_collation@ or @icuCollation@ and uses the default locale.
+
+Here is a sample settings:
+
+ {
+ "index" : {
+ "analysis" : {
+ "analyzer" : {
+ "collation" : {
+ "tokenizer" : "keyword",
+ "filter" : ["icu_collation"]
+ }
+ }
+ }
+ }
+ }
+
+And here is a sample of custom collation:
+
+ {
+ "index" : {
+ "analysis" : {
+ "analyzer" : {
+ "collation" : {
+ "tokenizer" : "keyword",
+ "filter" : ["myCollator"]
+ }
+ },
+ "filter" : {
+ "myCollator" : {
+ "type" : "icu_collation",
+ "language" : "en"
+ }
+ }
+ }
+ }
+ }
+
+
+ICU Tokenizer
+-------------
+
+Breaks text into words according to UAX #29: Unicode Text Segmentation ((http://www.unicode.org/reports/tr29/)).
+
+ {
+ "index" : {
+ "analysis" : {
+ "analyzer" : {
+ "collation" : {
+ "tokenizer" : "icu_tokenizer",
+ }
+ }
+ }
+ }
+ }
+
View
@@ -6,7 +6,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-analysis-icu</artifactId>
- <version>1.1.0-SNAPSHOT</version>
+ <version>1.1.0</version>
<packaging>jar</packaging>
<description>ICU Analysis for ElasticSearch</description>
<inceptionYear>2009</inceptionYear>
@@ -30,7 +30,6 @@
/**
- * @author joergprante
*/
public class IcuTransformTokenFilterFactory extends AbstractTokenFilterFactory {

0 comments on commit b61e27e

Please sign in to comment.