lucene-java-3.4.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/snowball/package.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <!--
   3  Licensed to the Apache Software Foundation (ASF) under one or more
   4  contributor license agreements.  See the NOTICE file distributed with
   5  this work for additional information regarding copyright ownership.
   6  The ASF licenses this file to You under the Apache License, Version 2.0
   7  (the "License"); you may not use this file except in compliance with
   8  the License.  You may obtain a copy of the License at
   9
  10      http://www.apache.org/licenses/LICENSE-2.0
  11
  12  Unless required by applicable law or agreed to in writing, software
  13  distributed under the License is distributed on an "AS IS" BASIS,
  14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  See the License for the specific language governing permissions and
  16  limitations under the License.
  17 -->
  18 <html>
  19 <body>
  20 {@link org.apache.lucene.analysis.TokenFilter} and {@link
  21 org.apache.lucene.analysis.Analyzer} implementations that use Snowball
  22 stemmers.
  23 <p>
  24 This project provides pre-compiled version of the Snowball stemmers
  25 based on revision 500 of the Tartarus Snowball repository,
  26 together with classes integrating them with the Lucene search engine.
  27 </p>
  28 <p>
  29 A few changes has been made to the static Snowball code and compiled stemmers:
  30 </p>
  31 <ul>
  32   <li>Class SnowballProgram is made abstract and contains new abstract method stem() to avoid reflection in Lucene filter class SnowballFilter.</li>
  33   <li>All use of StringBuffers has been refactored to StringBuilder for speed.</li>
  34   <li>Snowball BSD license header has been added to the Java classes to avoid having RAT adding ASL headers.</li>
  35 </ul>
  36 <p>
  37 See the Snowball <a href ="http://snowball.tartarus.org/">home page</a> for more information about the algorithms.
  38 </p>
  39
  40 <p>
  41 <b>IMPORTANT NOTICE ON BACKWARDS COMPATIBILITY!</b>
  42 </p>
  43 <p>
  44 An index created using the Snowball module in Lucene 2.3.2 and below
  45 might not be compatible with the Snowball module in Lucene 2.4 or greater.
  46 </p>
  47 <p>
  48 For more information about this issue see:
  49 https://issues.apache.org/jira/browse/LUCENE-1142
  50 </p>
  51
  52 </body>
  53 </html>