pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / analyzers / common / src / java / org / apache / lucene / analysis / hi / HindiNormalizationFilter.java
1 package org.apache.lucene.analysis.hi;
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 HindiNormalizer} to normalize the
30  * orthography.
31  * <p>
32  * In some cases the normalization may cause unrelated terms to conflate, so
33  * to prevent terms from being normalized use an instance of
34  * {@link KeywordMarkerFilter} or a custom {@link TokenFilter} that sets
35  * the {@link KeywordAttribute} before this {@link TokenStream}.
36  * </p>
37  * @see HindiNormalizer
38  */
39 public final class HindiNormalizationFilter extends TokenFilter {
40
41   private final HindiNormalizer normalizer = new HindiNormalizer();
42   private final CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
43   private final KeywordAttribute keywordAtt = addAttribute(KeywordAttribute.class);
44   
45   public HindiNormalizationFilter(TokenStream input) {
46     super(input);
47   }
48
49   @Override
50   public boolean incrementToken() throws IOException {
51     if (input.incrementToken()) {
52       if (!keywordAtt.isKeyword())
53         termAtt.setLength(normalizer.normalize(termAtt.buffer(), 
54             termAtt.length()));
55       return true;
56     } 
57     return false;
58   }
59 }