pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.4.0 / lucene / contrib / analyzers / common / src / java / org / apache / lucene / analysis / fr / FrenchStemFilter.java
diff --git a/lucene-java-3.4.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/fr/FrenchStemFilter.java b/lucene-java-3.4.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/fr/FrenchStemFilter.java
deleted file mode 100644 (file)
index 9be4841..0000000
+++ /dev/null
@@ -1,113 +0,0 @@
-package org.apache.lucene.analysis.fr;
-
-/**
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import org.apache.lucene.analysis.KeywordMarkerFilter;// for javadoc
-import org.apache.lucene.analysis.TokenFilter;
-import org.apache.lucene.analysis.TokenStream;
-import org.apache.lucene.analysis.snowball.SnowballFilter;
-import org.apache.lucene.analysis.tokenattributes.KeywordAttribute;
-import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;
-
-import java.io.IOException;
-import java.util.Map;
-import java.util.Set;
-
-/**
- * A {@link TokenFilter} that stems french words. 
- * <p>
- * The used stemmer can be changed at runtime after the
- * filter object is created (as long as it is a {@link FrenchStemmer}).
- * </p>
- * <p>
- * To prevent terms from being stemmed use an instance of
- * {@link KeywordMarkerFilter} or a custom {@link TokenFilter} that sets
- * the {@link KeywordAttribute} before this {@link TokenStream}.
- * </p>
- * @see KeywordMarkerFilter
- * @deprecated Use {@link SnowballFilter} with 
- * {@link org.tartarus.snowball.ext.FrenchStemmer} instead, which has the
- * same functionality. This filter will be removed in Lucene 5.0
- */
-@Deprecated
-public final class FrenchStemFilter extends TokenFilter {
-
-       /**
-        * The actual token in the input stream.
-        */
-       private FrenchStemmer stemmer = new FrenchStemmer();
-       private Set<?> exclusions = null;
-       
-       private final CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
-  private final KeywordAttribute keywordAttr = addAttribute(KeywordAttribute.class);
-
-       public FrenchStemFilter( TokenStream in ) {
-    super(in);
-       }
-
-  /**
-   * 
-   * @param in the {@link TokenStream} to filter
-   * @param exclusiontable a set of terms not to be stemmed
-   * @deprecated use {@link KeywordAttribute} with {@link KeywordMarkerFilter} instead.
-   */
-       @Deprecated
-       public FrenchStemFilter( TokenStream in, Set<?> exclusiontable ) {
-               this( in );
-               exclusions = exclusiontable;
-       }
-
-       /**
-        * @return  Returns true for the next token in the stream, or false at EOS
-        */
-       @Override
-       public boolean incrementToken() throws IOException {
-         if (input.incrementToken()) {
-           String term = termAtt.toString();
-
-           // Check the exclusion table
-           if ( !keywordAttr.isKeyword() && (exclusions == null || !exclusions.contains( term )) ) {
-             String s = stemmer.stem( term );
-             // If not stemmed, don't waste the time  adjusting the token.
-             if ((s != null) && !s.equals( term ) )
-               termAtt.setEmpty().append(s);
-           }
-           return true;
-         } else {
-           return false;
-         }
-       }
-       /**
-        * Set a alternative/custom {@link FrenchStemmer} for this filter.
-        */
-       public void setStemmer( FrenchStemmer stemmer ) {
-               if ( stemmer != null ) {
-                       this.stemmer = stemmer;
-               }
-       }
-       /**
-        * Set an alternative exclusion list for this filter.
-   * @deprecated use {@link KeywordAttribute} with {@link KeywordMarkerFilter} instead.
-        */
-       @Deprecated
-       public void setExclusionTable( Map<?,?> exclusiontable ) {
-               exclusions = exclusiontable.keySet();
-       }
-}
-
-