pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / analyzers / common / src / java / org / apache / lucene / analysis / ar / ArabicStemFilter.java
1 package org.apache.lucene.analysis.ar;
2
3 /**
4  * Licensed to the Apache Software Foundation (ASF) under one or more
5  * contributor license agreements.  See the NOTICE file distributed with
6  * this work for additional information regarding copyright ownership.
7  * The ASF licenses this file to You under the Apache License, Version 2.0
8  * (the "License"); you may not use this file except in compliance with
9  * the License.  You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 import java.io.IOException;
21
22 import org.apache.lucene.analysis.KeywordMarkerFilter;
23 import org.apache.lucene.analysis.TokenFilter;
24 import org.apache.lucene.analysis.TokenStream;
25 import org.apache.lucene.analysis.tokenattributes.KeywordAttribute;
26 import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;
27
28 /**
29  * A {@link TokenFilter} that applies {@link ArabicStemmer} to stem Arabic words..
30  * <p>
31  * To prevent terms from being stemmed use an instance of
32  * {@link KeywordMarkerFilter} or a custom {@link TokenFilter} that sets
33  * the {@link KeywordAttribute} before this {@link TokenStream}.
34  * </p>
35  * @see KeywordMarkerFilter */
36
37 public final class ArabicStemFilter extends TokenFilter {
38   private final ArabicStemmer stemmer = new ArabicStemmer();
39   private final CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
40   private final KeywordAttribute keywordAttr = addAttribute(KeywordAttribute.class);
41   
42   public ArabicStemFilter(TokenStream input) {
43     super(input);
44   }
45
46   @Override
47   public boolean incrementToken() throws IOException {
48     if (input.incrementToken()) {
49       if(!keywordAttr.isKeyword()) {
50         final int newlen = stemmer.stem(termAtt.buffer(), termAtt.length());
51         termAtt.setLength(newlen);
52       }
53       return true;
54     } else {
55       return false;
56     }
57   }
58 }