1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2007
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: KeyFilter.java 2050 2010-12-09 15:31:45Z dmsmith $
21   */
22  package org.crosswire.jsword.index.lucene.analysis;
23  
24  import java.io.IOException;
25  
26  import org.apache.lucene.analysis.TokenStream;
27  import org.crosswire.jsword.book.Book;
28  
29  /**
30   * A KeyFilter normalizes Key.
31   * 
32   * @see gnu.lgpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @author DM Smith [dmsmith555 at yahoo dot com]
35   */
36  public class KeyFilter extends AbstractBookTokenFilter {
37      /**
38       * Construct a KeyFilter not tied to a Book.
39       * 
40       * @param in
41       *            the input TokenStream
42       */
43      public KeyFilter(TokenStream in) {
44          this(null, in);
45      }
46  
47      /**
48       * Construct a KeyFilter tied to a Book.
49       * 
50       * @param book
51       *            the book to which this TokenFilter is tied.
52       * @param in
53       *            the input TokenStream
54       */
55      public KeyFilter(Book book, TokenStream in) {
56          super(book, in);
57      }
58  
59      /*
60       * (non-Javadoc)
61       * 
62       * @see org.apache.lucene.analysis.TokenStream#incrementToken()
63       */
64      @Override
65      public boolean incrementToken() throws IOException {
66          // TODO(DMS): actually normalize
67          return input.incrementToken();
68      }
69  }
70